Kemp.LoadBalancer.Powershell

Add-BondedInterface

WARNING: This function is deprecated. Use the following command instead: New-NetworkBondedInterface

WARNING: This function is deprecated. Use the following command instead:
New-NetworkBondedInterface

Syntax 

Add-BondedInterface -InterfaceID <Int16> -BondID <Int16> [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Add-BondedInterface -InterfaceID <Int16> -BondID <Int16> [-LoadBalancer <String>] [-LBPort <Int32>] 
[-CertificateStoreLocation <String>] [-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable 
<String>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-InterfaceID true false
-BondID true false
-LoadBalancer false false
-LBPort false false
-Credential false false
-InformationAction infa false false
-InformationVariable iv false false
-CertificateStoreLocation false false
-SubjectCN false false

AddCluster

WARNING: This function is deprecated. Use the following command instead: New-GeoCluster

WARNING: This function is deprecated. Use the following command instead:
New-GeoCluster

Syntax 

AddCluster -ClusterIp <String> -ClusterName <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

AddCluster -ClusterIp <String> -ClusterName <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation 
<String>] [-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-ClusterIp true false
-ClusterName true false
-LoadBalancer false false
-LBPort false false
-Credential false false
-InformationAction infa false false
-InformationVariable iv false false
-CertificateStoreLocation false false
-SubjectCN false false

AddCountry

WARNING: This function is deprecated. Use the following command instead: Set-GeoFQDNSiteCountry

WARNING: This function is deprecated. Use the following command instead:
Set-GeoFQDNSiteCountry

Syntax 

AddCountry -FQDN <String> -SiteAddress <String> [-CountryCode <String>] [-IsContinent <String>] [-CustomLocation <String>] 
[-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction <ActionPreference>] 
[-InformationVariable <String>] [<CommonParameters>]

AddCountry -FQDN <String> -SiteAddress <String> [-CountryCode <String>] [-IsContinent <String>] [-CustomLocation <String>] 
[-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN <String>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-FQDN true false
-SiteAddress true false
-CountryCode false false
-IsContinent false false
-CustomLocation false false
-LoadBalancer false false
-LBPort false false
-Credential false false
-InformationAction infa false false
-InformationVariable iv false false
-CertificateStoreLocation false false
-SubjectCN false false

AddCustomLocation

WARNING: This function is deprecated. Use the following command instead: New-GeoCustomLocation

WARNING: This function is deprecated. Use the following command instead:
New-GeoCustomLocation

Syntax 

AddCustomLocation -Location <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

AddCustomLocation -Location <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] 
[-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-Location true false
-LoadBalancer false false
-LBPort false false
-Credential false false
-InformationAction infa false false
-InformationVariable iv false false
-CertificateStoreLocation false false
-SubjectCN false false

AddFQDN

WARNING: This function is deprecated. Use the following command instead: New-GeoFQDN

WARNING: This function is deprecated. Use the following command instead:
New-GeoFQDN

Syntax 

AddFQDN -FQDN <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

AddFQDN -FQDN <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN 
<String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-FQDN true false
-LoadBalancer false false
-LBPort false false
-Credential false false
-InformationAction infa false false
-InformationVariable iv false false
-CertificateStoreLocation false false
-SubjectCN false false

Add-GeoFQDN

WARNING: This function is deprecated. Use the following command instead: New-GeoFQDN

WARNING: This function is deprecated. Use the following command instead:
New-GeoFQDN

Syntax 

Add-GeoFQDN -FQDN <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Add-GeoFQDN -FQDN <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN 
<String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-FQDN The name of the FQDN. true false
-LoadBalancer Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		 false false
-LBPort Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		 false false
-Credential The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		 false false
-InformationAction infa false false
-InformationVariable iv false false
-CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command.
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		 false false
-SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN),
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		 false false

Examples

Example 
Add-GeoFQDN –FQDN <FQDNName>
Example Output: Ok

Top of page

Add-InterfaceAddress

WARNING: This function is deprecated. Use the following command instead: New-NetworkInterfaceAdditionalAddress

WARNING: This function is deprecated. Use the following command instead:
New-NetworkInterfaceAdditionalAddress

Syntax 

Add-InterfaceAddress [-InterfaceID <Int16>] [-Address <String>] [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential 
<Object>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Add-InterfaceAddress [-InterfaceID <Int16>] [-Address <String>] [-LoadBalancer <String>] [-LBPort <Int32>] 
[-CertificateStoreLocation <String>] [-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable 
<String>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-InterfaceID false false
-Address false false
-LoadBalancer false false
-LBPort false false
-Credential false false
-InformationAction infa false false
-InformationVariable iv false false
-CertificateStoreLocation false false
-SubjectCN false false

AddIP

WARNING: This function is deprecated. Use the following command instead: New-GeoIpRange

WARNING: This function is deprecated. Use the following command instead:
New-GeoIpRange

Syntax 

AddIP -IP <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

AddIP -IP <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN <String>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-IP true false
-LoadBalancer false false
-LBPort false false
-Credential false false
-InformationAction infa false false
-InformationVariable iv false false
-CertificateStoreLocation false false
-SubjectCN false false

AddIPCountry

WARNING: This function is deprecated. Use the following command instead: Set-GeoIPRangeCountry

WARNING: This function is deprecated. Use the following command instead:
Set-GeoIPRangeCountry

Syntax 

AddIPCountry -IP <String> -CountryCode <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

AddIPCountry -IP <String> -CountryCode <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation 
<String>] [-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-IP true false
-CountryCode true false
-LoadBalancer false false
-LBPort false false
-Credential false false
-InformationAction infa false false
-InformationVariable iv false false
-CertificateStoreLocation false false
-SubjectCN false false

AddIPCountryCustom

WARNING: This function is deprecated. Use the following command instead: Set-GeoIPRangeCustomLocation

WARNING: This function is deprecated. Use the following command instead:
Set-GeoIPRangeCustomLocation

Syntax 

AddIPCountryCustom -IP <String> -CustomLoc <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

AddIPCountryCustom -IP <String> -CustomLoc <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation 
<String>] [-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-IP true false
-CustomLoc true false
-LoadBalancer false false
-LBPort false false
-Credential false false
-InformationAction infa false false
-InformationVariable iv false false
-CertificateStoreLocation false false
-SubjectCN false false

AddMap

WARNING: This function is deprecated. Use the following command instead: New-GeoFQDNSiteAddress

WARNING: This function is deprecated. Use the following command instead:
New-GeoFQDNSiteAddress

Syntax 

AddMap -FQDN <String> -SiteAddress <String> [-Cluster <String>] [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential 
<Object>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

AddMap -FQDN <String> -SiteAddress <String> [-Cluster <String>] [-LoadBalancer <String>] [-LBPort <Int32>] 
[-CertificateStoreLocation <String>] [-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable 
<String>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-FQDN true false
-SiteAddress true false
-Cluster false false
-LoadBalancer false false
-LBPort false false
-Credential false false
-InformationAction infa false false
-InformationVariable iv false false
-CertificateStoreLocation false false
-SubjectCN false false

Add-NoCacheExtension

WARNING: This function is deprecated. Use the following command instead: New-AdcHttpCacheException

WARNING: This function is deprecated. Use the following command instead:
New-AdcHttpCacheException

Syntax 

Add-NoCacheExtension -Extension <String[]> [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Add-NoCacheExtension -Extension <String[]> [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] 
[-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-Extension true true (ByValue)
-LoadBalancer false false
-LBPort false false
-Credential false false
-InformationAction infa false false
-InformationVariable iv false false
-CertificateStoreLocation false false
-SubjectCN false false

Add-NoCompressExtension

WARNING: This function is deprecated. Use the following command instead: New-AdcHttpCompressionException

WARNING: This function is deprecated. Use the following command instead:
New-AdcHttpCompressionException

Syntax 

Add-NoCompressExtension -Extension <String[]> [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Add-NoCompressExtension -Extension <String[]> [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation 
<String>] [-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-Extension true true (ByValue)
-LoadBalancer false false
-LBPort false false
-Credential false false
-InformationAction infa false false
-InformationVariable iv false false
-CertificateStoreLocation false false
-SubjectCN false false

AddSDNController

WARNING: This function is deprecated. Use the following command instead: New-SdnController

WARNING: This function is deprecated. Use the following command instead:
New-SdnController

Syntax 

AddSDNController -IPV4 <String> -Port <Int32> [-Clid <Int32>] [-Https <Boolean>] [-User <String>] [-Password <String>] 
[-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction <ActionPreference>] 
[-InformationVariable <String>] [<CommonParameters>]

AddSDNController -IPV4 <String> -Port <Int32> [-Clid <Int32>] [-Https <Boolean>] [-User <String>] [-Password <String>] 
[-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN <String>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-IPV4 true false
-Port true false
-Clid false false
-Https false false
-User false false
-Password false false
-LoadBalancer false false
-LBPort false false
-Credential false false
-InformationAction infa false false
-InformationVariable iv false false
-CertificateStoreLocation false false
-SubjectCN false false

Add-VLan

WARNING: This function is deprecated. Use the following command instead: New-NetworkVLAN

WARNING: This function is deprecated. Use the following command instead:
New-NetworkVLAN

Syntax 

Add-VLan -InterfaceID <Int16> -VLanId <Int16> [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Add-VLan -InterfaceID <Int16> -VLanId <Int16> [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation 
<String>] [-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-InterfaceID true false
-VLanId true false
-LoadBalancer false false
-LBPort false false
-Credential false false
-InformationAction infa false false
-InformationVariable iv false false
-CertificateStoreLocation false false
-SubjectCN false false

Add-VxLan

WARNING: This function is deprecated. Use the following command instead: New-NetworkVxLAN

WARNING: This function is deprecated. Use the following command instead:
New-NetworkVxLAN

Syntax 

Add-VxLan -InterfaceID <Int16> -VNI <Int32> -Addr <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential 
<Object>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Add-VxLan -InterfaceID <Int16> -VNI <Int32> -Addr <String> [-LoadBalancer <String>] [-LBPort <Int32>] 
[-CertificateStoreLocation <String>] [-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable 
<String>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-InterfaceID true false
-VNI true false
-Addr true false
-LoadBalancer false false
-LBPort false false
-Credential false false
-InformationAction infa false false
-InformationVariable iv false false
-CertificateStoreLocation false false
-SubjectCN false false

AddWafCustomData

WARNING: This function is deprecated. Use the following command instead: New-WafCustomRuleData

WARNING: This function is deprecated. Use the following command instead:
New-WafCustomRuleData

Syntax 

AddWafCustomData -Path <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

AddWafCustomData -Path <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN 
<String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-Path true false
-LoadBalancer false false
-LBPort false false
-Credential false false
-InformationAction infa false false
-InformationVariable iv false false
-CertificateStoreLocation false false
-SubjectCN false false

AddWafCustomRule

WARNING: This function is deprecated. Use the following command instead: New-WafCustomRuleSet

WARNING: This function is deprecated. Use the following command instead:
New-WafCustomRuleSet

Syntax 

AddWafCustomRule -Path <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

AddWafCustomRule -Path <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN 
<String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-Path true false
-LoadBalancer false false
-LBPort false false
-Credential false false
-InformationAction infa false false
-InformationVariable iv false false
-CertificateStoreLocation false false
-SubjectCN false false

AfeClientLimitAdd

WARNING: This function is deprecated. Use the following command instead: New-LmIPConnectionLimit

WARNING: This function is deprecated. Use the following command instead:
New-LmIPConnectionLimit

Syntax 

AfeClientLimitAdd -L7addr <String> -L7limit <Int32> [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

AfeClientLimitAdd -L7addr <String> -L7limit <Int32> [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation 
<String>] [-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-L7addr true false
-L7limit true false
-LoadBalancer false false
-LBPort false false
-Credential false false
-InformationAction infa false false
-InformationVariable iv false false
-CertificateStoreLocation false false
-SubjectCN false false

AfeClientLimitDelete

WARNING: This function is deprecated. Use the following command instead: Remove-LmIPConnectionLimit

WARNING: This function is deprecated. Use the following command instead:
Remove-LmIPConnectionLimit

Syntax 

AfeClientLimitDelete -L7addr <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

AfeClientLimitDelete -L7addr <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] 
[-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-L7addr true false
-LoadBalancer false false
-LBPort false false
-Credential false false
-InformationAction infa false false
-InformationVariable iv false false
-CertificateStoreLocation false false
-SubjectCN false false

AfeClientLimitList

WARNING: This function is deprecated. Use the following command instead: Get-LmIPConnectionLimit

WARNING: This function is deprecated. Use the following command instead:
Get-LmIPConnectionLimit

Syntax 

AfeClientLimitList [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

AfeClientLimitList [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN <String>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-LoadBalancer false false
-LBPort false false
-Credential false false
-InformationAction infa false false
-InformationVariable iv false false
-CertificateStoreLocation false false
-SubjectCN false false

Backup-Certificate

WARNING: This function is deprecated. Use the following command instead: Backup-TlsCertificate

WARNING: This function is deprecated. Use the following command instead:
Backup-TlsCertificate

Syntax 

Backup-Certificate -Password <String> [-Path <String>] [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] 
[-Force <SwitchParameter>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Backup-Certificate -Password <String> [-Path <String>] [-LoadBalancer <String>] [-LBPort <Int32>] 
[-CertificateStoreLocation <String>] [-SubjectCN <String>] [-Force <SwitchParameter>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-Password true false
-Path false false
-LoadBalancer false false
-LBPort false false
-Credential false false
-Force false false
-InformationAction infa false false
-InformationVariable iv false false
-CertificateStoreLocation false false
-SubjectCN false false

Backup-LmConfiguration

Allows you to back up the LoadMaster.

Allows you to back up the LoadMaster.

Syntax 

Backup-LmConfiguration -Path <String> [-Force <SwitchParameter>] [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential 
<Object>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Backup-LmConfiguration -Path <String> [-Force <SwitchParameter>] [-LoadBalancer <String>] [-LBPort <Int32>] 
[-CertificateStoreLocation <String>] [-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable 
<String>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-Path The local path where the LoadMaster backup file should be saved. true false
-Force Switch to force the command to execute without a confirmation. false false
-LoadBalancer Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		 false false
-LBPort Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		 false false
-Credential The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		 false false
-InformationAction infa false false
-InformationVariable iv false false
-CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command.
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		 false false
-SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN),
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		 false false

Examples

Example 
Backup-LmConfiguration -Path c:\backup\backup.file
Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed.

Top of page

Backup-LoadBalancer

WARNING: This function is deprecated. Use the following command instead: Backup-LmConfiguration

WARNING: This function is deprecated. Use the following command instead:
Backup-LmConfiguration

Syntax 

Backup-LoadBalancer -Path <String> [-Force <SwitchParameter>] [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential 
<Object>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Backup-LoadBalancer -Path <String> [-Force <SwitchParameter>] [-LoadBalancer <String>] [-LBPort <Int32>] 
[-CertificateStoreLocation <String>] [-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable 
<String>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-Path true false
-Force false false
-LoadBalancer false false
-LBPort false false
-Credential false false
-InformationAction infa false false
-InformationVariable iv false false
-CertificateStoreLocation false false
-SubjectCN false false

Backup-TlsCertificate

Create a backup of all the certificates and intermediate certificates on the LoadMaster.

The password will be required to restore the certificate file to the load balancer.

Syntax 

Backup-TlsCertificate -Password <String> [-Path <String>] [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] 
[-Force <SwitchParameter>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Backup-TlsCertificate -Password <String> [-Path <String>] [-LoadBalancer <String>] [-LBPort <Int32>] 
[-CertificateStoreLocation <String>] [-SubjectCN <String>] [-Force <SwitchParameter>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-Password A password to encrypt the certificate backup file. This password will be needed to restore the certificate file to the
LoadMaster.		 true false
-Path The local path where the certificate backup file should be saved. If no file is specified, the backup file will be saved as
C:\Temp\CertificateBackup_yyyy-MM-dd_HH-mm-ss, assuming that C:\ is the System Root drive specified in the Environment
variables.


If the input parameter Path is not set, the default location where the cmdlet tries to save the TlsCertificate is:
$($Env:SystemRoot)\Temp
If the above folder does not exist or it is not accessible (permissions) the cmdlet will fail.		 false false
-LoadBalancer Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		 false false
-LBPort Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		 false false
-Credential The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		 false false
-Force Enable this parameter to force the command to execute without a confirmation. false false
-InformationAction infa false false
-InformationVariable iv false false
-CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command.
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		 false false
-SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN),
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		 false false

Examples

Example 
Backup-TlsCertificate -Password password -Path C:\temp\CertBackup_2017_04_28.16.09
Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed.

Top of page

ChangeCheckerAddr

WARNING: This function is deprecated. Use the following command instead: Set-GeoFQDNSiteCheckerAddress

WARNING: This function is deprecated. Use the following command instead:
Set-GeoFQDNSiteCheckerAddress

Syntax 

ChangeCheckerAddr -FQDN <String> -SiteAddress <String> -CheckerIP <String> [-CheckerPort] <String> [-LoadBalancer <String>] 
[-LBPort <Int32>] [-Credential <Object>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] 
[<CommonParameters>]

ChangeCheckerAddr -FQDN <String> -SiteAddress <String> -CheckerIP <String> [-CheckerPort] <String> [-LoadBalancer <String>] 
[-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN <String>] [-InformationAction <ActionPreference>] 
[-InformationVariable <String>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-FQDN true false
-SiteAddress true false
-CheckerIP true false
-CheckerPort true false
-LoadBalancer false false
-LBPort false false
-Credential false false
-InformationAction infa false false
-InformationVariable iv false false
-CertificateStoreLocation false false
-SubjectCN false false

ChangeMapLocation

WARNING: This function is deprecated. Use the following command instead: Set-GeoFQDNSiteCoordinates

WARNING: This function is deprecated. Use the following command instead:
Set-GeoFQDNSiteCoordinates

Syntax 

ChangeMapLocation -FQDN <String> -SiteAddress <String> -Lat <Int32> -Long <Int32> [-LoadBalancer <String>] [-LBPort 
<Int32>] [-Credential <Object>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

ChangeMapLocation -FQDN <String> -SiteAddress <String> -Lat <Int32> -Long <Int32> [-LoadBalancer <String>] [-LBPort 
<Int32>] [-CertificateStoreLocation <String>] [-SubjectCN <String>] [-InformationAction <ActionPreference>] 
[-InformationVariable <String>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-FQDN true false
-SiteAddress true false
-Lat true false
-Long true false
-LoadBalancer false false
-LBPort false false
-Credential false false
-InformationAction infa false false
-InformationVariable iv false false
-CertificateStoreLocation false false
-SubjectCN false false

Clear-SSOCache

Flush the SSO authentication cache.

Flush the SSO authentication cache.

Syntax 

Clear-SSOCache [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction <ActionPreference>] 
[-InformationVariable <String>] [<CommonParameters>]

Clear-SSOCache [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN <String>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-LoadBalancer Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		 false false
-LBPort Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		 false false
-Credential The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		 false false
-InformationAction infa false false
-InformationVariable iv false false
-CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command.
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		 false false
-SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN),
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		 false false

Examples

Example 
Clear-SSOCache
Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed.

Top of page

ClusterChangeLocation

WARNING: This function is deprecated. Use the following command instead: Set-GeoClusterCoordinates

WARNING: This function is deprecated. Use the following command instead:
Set-GeoClusterCoordinates

Syntax 

ClusterChangeLocation -ClusterIp <String> -LatSecs <Int32> -LongSecs <Int32> [-LoadBalancer <String>] [-LBPort <Int32>] 
[-Credential <Object>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

ClusterChangeLocation -ClusterIp <String> -LatSecs <Int32> -LongSecs <Int32> [-LoadBalancer <String>] [-LBPort <Int32>] 
[-CertificateStoreLocation <String>] [-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable 
<String>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-ClusterIp true false
-LatSecs true false
-LongSecs true false
-LoadBalancer false false
-LBPort false false
-Credential false false
-InformationAction infa false false
-InformationVariable iv false false
-CertificateStoreLocation false false
-SubjectCN false false

Confirm-LicenseEULA

Used to enter the magic cookie key returned by the ReadEula command to accept the EULA and to set the type of license used, for example trial, perm or free.

When this command is run successfully, a second EULA and magic string will be displayed.


Value Description
Trial Temporary license for users evaluating the Kemp LoadMaster
Perm Purchased permanent LoadMaster
Free Free LoadMaster

Syntax 

Confirm-LicenseEULA [[-Type] <String>] [-Magic] <String> [[-LoadBalancer] <String>] [[-LBPort] <Int32>] [[-Credential] 
<Object>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-Type Use this parameter to specify the type of license that is being employed.
The type parameter is legacy. The default value of the type parameter is Trial. This can be overwritten by setting the type
parameter when running the Confirm-LicenseEULA command.
Valid values for the type parameter are:
Perm - Perpetual
Free - Free (Restricted)
Trial – Trial (Unrestricted)		 false false
-Magic The key that is is generated by the ReadEULA command. true false
-LoadBalancer Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		 false false
-LBPort Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		 false false
-Credential The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		 false false
-InformationAction infa false false
-InformationVariable iv false false

Note

Currently there are three license types available from Kemp. These are: Trial (Unrestricted), Perpetual and Free (Restricted).

Examples

Example 
$confirm = Confirm-LicenseEULA -Magic 82745495-48f8-4fec-895c-c21f9297d989 -Type trial

$confirm
Example Output: Full response: @{Eula2=} Return Code..: 200 Response.....: Command successfully executed Data field...: Eula2 ----- @{MagicString=20864369-5d36-407c-874d-772e610c8bbc; Eula2=... Eula ---- @{MagicString=013b50b2-e3bb-468e-b64a-de78d46cdfb8; Eula=... Param........: MagicString Eula2 ----------- ----- 20864369-5d36-407c-874d-772e610c8bbc ... Param........: As part of Kemps continuous drive to offer better value and services to our customers Kemp has introduced a Call Home feature. The LoadMaster can utilize Call Home to get available license updates, information regarding any updated firmware for your product and provide system status information to Kemp. The system st atus information will include Throughput, Enabled Features, Virtual Services and Real Servers details but will not include any unique personal information or actual traffic from your network. Your LoadMaster will initiate a connection to Kemp once during any 24 hour interval. <b>NOTE</b> – Allowing Call Home is mandatory for Free LoadMaster versions. For more details on this visit <a href="http://www.kemptechnologies.com/callhome" target="_blank">www.kemptechnologies.com/callhome</a>

Top of page

Confirm-LicenseEULA2

Specify whether or not to use the Call Home feature.

If this is enabled, the LoadMaster regularly contacts Kemp to check for updates and other information.

Syntax 

Confirm-LicenseEULA2 [-Magic] <String> [-Accept] <String> [[-LoadBalancer] <String>] [[-LBPort] <Int32>] [[-Credential] 
<Object>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-Magic The IP Address for the Kemp LoadMaster to which the command is being directed. This key is generated by running the
ReadEULA command.		 true false
-Accept This parameter is used to accept or reject the license agreement. The possible values are; yes and no. true false
-LoadBalancer Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		 false false
-LBPort Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		 false false
-Credential The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		 false false
-InformationAction infa false false
-InformationVariable iv false false

Examples

Example 
$confirm = Confirm-LicenseEULA2 -Accept yes -Magic 20864369-5d36-407c-874d-772e610c8bbc

$confirm
Example Output: Full response: Command successfully executed Return Code..: 200 Response.....: Command successfully executed Data field...:

Top of page

CreateVpnConnection

WARNING: This function is deprecated. Use the following command instead: New-LmVpnConnection

WARNING: This function is deprecated. Use the following command instead:
New-LmVpnConnection

Syntax 

CreateVpnConnection -Name <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

CreateVpnConnection -Name <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] 
[-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-Name true false
-LoadBalancer false false
-LBPort false false
-Credential false false
-InformationAction infa false false
-InformationVariable iv false false
-CertificateStoreLocation false false
-SubjectCN false false

DelCipherset

WARNING: This function is deprecated. Use the following command instead: Remove-TlsCipherSet

WARNING: This function is deprecated. Use the following command instead:
Remove-TlsCipherSet

Syntax 

DelCipherset -Name <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

DelCipherset -Name <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN 
<String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-Name true false
-LoadBalancer false false
-LBPort false false
-Credential false false
-InformationAction infa false false
-InformationVariable iv false false
-CertificateStoreLocation false false
-SubjectCN false false

DeleteAddon

WARNING: This function is deprecated. Use the following command instead: Remove-LmAddon

WARNING: This function is deprecated. Use the following command instead:
Remove-LmAddon

Syntax 

DeleteAddon -Name <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

DeleteAddon -Name <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN 
<String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-Name true false
-LoadBalancer false false
-LBPort false false
-Credential false false
-InformationAction infa false false
-InformationVariable iv false false
-CertificateStoreLocation false false
-SubjectCN false false

DeleteCluster

WARNING: This function is deprecated. Use the following command instead: Remove-GeoCluster

WARNING: This function is deprecated. Use the following command instead:
Remove-GeoCluster

Syntax 

DeleteCluster -ClusterIp <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

DeleteCluster -ClusterIp <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] 
[-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-ClusterIp true false
-LoadBalancer false false
-LBPort false false
-Credential false false
-InformationAction infa false false
-InformationVariable iv false false
-CertificateStoreLocation false false
-SubjectCN false false

DeleteCustomLocation

WARNING: This function is deprecated. Use the following command instead: Remove-GeoCustomLocation

WARNING: This function is deprecated. Use the following command instead:
Remove-GeoCustomLocation

Syntax 

DeleteCustomLocation -Location <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

DeleteCustomLocation -Location <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] 
[-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-Location true false
-LoadBalancer false false
-LBPort false false
-Credential false false
-InformationAction infa false false
-InformationVariable iv false false
-CertificateStoreLocation false false
-SubjectCN false false

DeleteFQDN

WARNING: This function is deprecated. Use the following command instead: Remove-GeoFQDN

WARNING: This function is deprecated. Use the following command instead:
Remove-GeoFQDN

Syntax 

DeleteFQDN -FQDN <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

DeleteFQDN -FQDN <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN 
<String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-FQDN true false
-LoadBalancer false false
-LBPort false false
-Credential false false
-InformationAction infa false false
-InformationVariable iv false false
-CertificateStoreLocation false false
-SubjectCN false false

DeleteIP

WARNING: This function is deprecated. Use the following command instead: Remove-GeoIpRange

WARNING: This function is deprecated. Use the following command instead:
Remove-GeoIpRange

Syntax 

DeleteIP -IP <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

DeleteIP -IP <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN <String>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-IP true false
-LoadBalancer false false
-LBPort false false
-Credential false false
-InformationAction infa false false
-InformationVariable iv false false
-CertificateStoreLocation false false
-SubjectCN false false

DeleteIPLocation

WARNING: This function is deprecated. Use the following command instead: Remove-GeoIPRangeCoordinates

WARNING: This function is deprecated. Use the following command instead:
Remove-GeoIPRangeCoordinates

Syntax 

DeleteIPLocation -IP <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

DeleteIPLocation -IP <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN 
<String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-IP true false
-LoadBalancer false false
-LBPort false false
-Credential false false
-InformationAction infa false false
-InformationVariable iv false false
-CertificateStoreLocation false false
-SubjectCN false false

DeleteMap

WARNING: This function is deprecated. Use the following command instead: Remove-GeoFQDNSiteAddress

WARNING: This function is deprecated. Use the following command instead:
Remove-GeoFQDNSiteAddress

Syntax 

DeleteMap -FQDN <String> -SiteAddress <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

DeleteMap -FQDN <String> -SiteAddress <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation 
<String>] [-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-FQDN true false
-SiteAddress true false
-LoadBalancer false false
-LBPort false false
-Credential false false
-InformationAction infa false false
-InformationVariable iv false false
-CertificateStoreLocation false false
-SubjectCN false false

DeleteSDNController

WARNING: This function is deprecated. Use the following command instead: Remove-SdnController

WARNING: This function is deprecated. Use the following command instead:
Remove-SdnController

Syntax 

DeleteSDNController [-Clid <Int32>] [-Cid <Int32>] [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

DeleteSDNController [-Clid <Int32>] [-Cid <Int32>] [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation 
<String>] [-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-Clid false false
-Cid false false
-LoadBalancer false false
-LBPort false false
-Credential false false
-InformationAction infa false false
-InformationVariable iv false false
-CertificateStoreLocation false false
-SubjectCN false false

DeleteTemplate

WARNING: This function is deprecated. Use the following command instead: Remove-Template

WARNING: This function is deprecated. Use the following command instead:
Remove-Template

Syntax 

DeleteTemplate -Name <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

DeleteTemplate -Name <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN 
<String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-Name true false
-LoadBalancer false false
-LBPort false false
-Credential false false
-InformationAction infa false false
-InformationVariable iv false false
-CertificateStoreLocation false false
-SubjectCN false false

DeleteVpnConnection

WARNING: This function is deprecated. Use the following command instead: Remove-LmVpnConnection

WARNING: This function is deprecated. Use the following command instead:
Remove-LmVpnConnection

Syntax 

DeleteVpnConnection -Name <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

DeleteVpnConnection -Name <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] 
[-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-Name true false
-LoadBalancer false false
-LBPort false false
-Credential false false
-InformationAction infa false false
-InformationVariable iv false false
-CertificateStoreLocation false false
-SubjectCN false false

DelWafCustomData

WARNING: This function is deprecated. Use the following command instead: Uninstall-WafCustomRuleData

WARNING: This function is deprecated. Use the following command instead:
Uninstall-WafCustomRuleData

Syntax 

DelWafCustomData -Filename <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

DelWafCustomData -Filename <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] 
[-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-Filename true false
-LoadBalancer false false
-LBPort false false
-Credential false false
-InformationAction infa false false
-InformationVariable iv false false
-CertificateStoreLocation false false
-SubjectCN false false

DelWafCustomRule

WARNING: This function is deprecated. Use the following command instead: Uninstall-WafCustomRuleSet

WARNING: This function is deprecated. Use the following command instead:
Uninstall-WafCustomRuleSet

Syntax 

DelWafCustomRule -Filename <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

DelWafCustomRule -Filename <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] 
[-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-Filename true false
-LoadBalancer false false
-LBPort false false
-Credential false false
-InformationAction infa false false
-InformationVariable iv false false
-CertificateStoreLocation false false
-SubjectCN false false

Disable-AdcRealServer

Disables the specified Real Server.

Disables the specified Real Server.

Syntax 

Disable-AdcRealServer -RSIpaddress <String> [-RSPort <Int32>] [-RSFqdn <String>] [-LoadBalancer <String>] [-LBPort <Int32>] 
[-Credential <Object>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Disable-AdcRealServer -RSIpaddress <String> [-RSPort <Int32>] [-RSFqdn <String>] [-LoadBalancer <String>] [-LBPort <Int32>] 
[-CertificateStoreLocation <String>] [-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable 
<String>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-RSIpaddress The IP address of the Real Server to disable. true false
-RSPort The port of the Real Server to disable. false false
-RSFqdn The Fully Qualified Domain Name (FQDN) of the Real Server to disable. false false
-LoadBalancer Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		 false false
-LBPort Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		 false false
-Credential The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		 false false
-InformationAction infa false false
-InformationVariable iv false false
-CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command.
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		 false false
-SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN),
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		 false false
-IPAddress The IP Address of the Real Server that should be disabled on the load balancer. This parameter is required.
The IP address can be in either the IPv4 or IPv6 formats.		 true false

Examples

Example 
Disable-AdcRealServer -IPAddress 10.11.0.24
Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed.

Top of page

Disable-ClusterNode

Disables the specified node.

Disables the specified node.

Syntax 

Disable-ClusterNode -NodeId <Int32> [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Disable-ClusterNode -NodeId <Int32> [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] 
[-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-NodeId The ID number of the node to be disabled. The ID of the node can be found in the ID column in the Cluster Control screen in
the LoadMaster WUI.		 true false
-LoadBalancer Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		 false false
-LBPort Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		 false false
-Credential The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		 false false
-InformationAction infa false false
-InformationVariable iv false false
-CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command.
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		 false false
-SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN),
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		 false false

Examples

Example 
Disable-ClusterNode -NodeId 2
Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed.

Top of page

DisableGEO

WARNING: This function is deprecated. Use the following command instead: Disable-LmGeoPack

WARNING: This function is deprecated. Use the following command instead:
Disable-LmGeoPack

Syntax 

DisableGEO [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction <ActionPreference>] 
[-InformationVariable <String>] [<CommonParameters>]

DisableGEO [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN <String>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-LoadBalancer false false
-LBPort false false
-Credential false false
-InformationAction infa false false
-InformationVariable iv false false
-CertificateStoreLocation false false
-SubjectCN false false

Disable-LmGeoPack

Disables GEO globally for the LoadMaster.

Disables GEO globally for the LoadMaster.

Syntax 

Disable-LmGeoPack [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction <ActionPreference>] 
[-InformationVariable <String>] [<CommonParameters>]

Disable-LmGeoPack [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN <String>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-LoadBalancer Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		 false false
-LBPort Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		 false false
-Credential The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		 false false
-InformationAction infa false false
-InformationVariable iv false false
-CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command.
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		 false false
-SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN),
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		 false false

Examples

Example 
Disable-LmGeoPack
Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed.

Top of page

Disable-RealServer

WARNING: This function is deprecated. Use the following command instead: Disable-AdcRealServer

WARNING: This function is deprecated. Use the following command instead:
Disable-AdcRealServer

Syntax 

Disable-RealServer -RSIpaddress <String> [-RSPort <Int32>] [-RSFqdn <String>] [-LoadBalancer <String>] [-LBPort <Int32>] 
[-Credential <Object>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Disable-RealServer -RSIpaddress <String> [-RSPort <Int32>] [-RSFqdn <String>] [-LoadBalancer <String>] [-LBPort <Int32>] 
[-CertificateStoreLocation <String>] [-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable 
<String>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-RSIpaddress true false
-RSPort false false
-RSFqdn false false
-LoadBalancer false false
-LBPort false false
-Credential false false
-InformationAction infa false false
-InformationVariable iv false false
-CertificateStoreLocation false false
-SubjectCN false false

Disable-SecAPIAccess

Disables the programmable Application Program Interface (API).

Run this command to disable the API interface.

Syntax 

Disable-SecAPIAccess [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Disable-SecAPIAccess [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN <String>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-LoadBalancer Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		 false false
-LBPort Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		 false false
-Credential The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		 false false
-InformationAction infa false false
-InformationVariable iv false false
-CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command.
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		 false false
-SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN),
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		 false false

Note

If this is disabled, the API will no longer be accessible.

Examples

Example 
Disable-SecAPIAccess
Example Output: Full response: @{ReturnCode=200; Response=The API is disabled; Data=} Return Code..: 200 Response.....: The API is disabled

Top of page

DisableWafRemoteLogging

WARNING: This function is deprecated. Use the following command instead: Disable-WafRemoteLogging

WARNING: This function is deprecated. Use the following command instead:
Disable-WafRemoteLogging

Syntax 

DisableWafRemoteLogging [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

DisableWafRemoteLogging [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN 
<String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-LoadBalancer false false
-LBPort false false
-Credential false false
-InformationAction infa false false
-InformationVariable iv false false
-CertificateStoreLocation false false
-SubjectCN false false

Disable-WafRemoteLogging

Allows you to turn off WAF remote logging.

Allows you to turn off WAF remote logging.

Syntax 

Disable-WafRemoteLogging [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Disable-WafRemoteLogging [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN 
<String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-LoadBalancer Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		 false false
-LBPort Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		 false false
-Credential The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		 false false
-InformationAction infa false false
-InformationVariable iv false false
-CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command.
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		 false false
-SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN),
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		 false false

Examples

Example 
Disable-WafRemoteLogging -LoadBalancer <LoadMasterIPAddress>
Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed.

Top of page

DoTcpDump

WARNING: This function is deprecated. Use the following command instead: Trace-TcpTraffic

WARNING: This function is deprecated. Use the following command instead:
Trace-TcpTraffic

Syntax 

DoTcpDump [-MaxPackets <Int32>] [-MaxTime <Int32>] [-Interface <String>] [-Port <String>] [-Address <String>] [-TcpOptions 
<String>] [-Path <String>] [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-Force <SwitchParameter>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [-WhatIf <SwitchParameter>] [-Confirm 
<SwitchParameter>] [<CommonParameters>]

DoTcpDump [-MaxPackets <Int32>] [-MaxTime <Int32>] [-Interface <String>] [-Port <String>] [-Address <String>] [-TcpOptions 
<String>] [-Path <String>] [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN 
<String>] [-Force <SwitchParameter>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [-WhatIf 
<SwitchParameter>] [-Confirm <SwitchParameter>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-MaxPackets The maximum number of packets to capture. The default value for this parameter is 10000. Valid values range from 1 to
200000. The maximum is the API maximum. The actual maximum size is defined by the space available.		 false false
-MaxTime The maximum number of seconds to capture. The default value for this parameter is 10. Valid values range from 1 to 600. false false
-Interface The interface(s) to monitor. The default interface is eth0. A TCP dump can be captured either by one or all Ethernet ports. false false
-Port The port to be monitored. false false
-Address The (optional) address to be monitored. false false
-TcpOptions Any additional TCPDump parameters needed. The maximum number of characters permitted is 255. false false
-Path The path to export a saved file to. If the path parameter is not populated, the path defaults to
<WindowsDirectory>\Temp\tcpdump_<Timestamp>.pcap.		 false false
-LoadBalancer Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		 false false
-LBPort Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		 false false
-Credential The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		 false false
-Force false false
-InformationAction infa false false
-InformationVariable iv false false
-WhatIf wi false false
-Confirm cf false false
-CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command.
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		 false false
-SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN),
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		 false false

Examples

Example 
DoTcpDump -MaxPackets 15000 -Interface any -Port 443 -MaxTime 800 -Path c:\temp\out.pcap
Example Output: No output is displayed, but a file will be downloaded to the specified path.

Top of page

DownloadWafAuditLog

WARNING: This function is deprecated. Use the following command instead: Export-WafAuditLog

WARNING: This function is deprecated. Use the following command instead:
Export-WafAuditLog

Syntax 

DownloadWafAuditLog [-Path <String>] -AuditFile <String> [-Filter <String>] [-LoadBalancer <String>] [-LBPort <Int32>] 
[-Credential <Object>] [-Force <SwitchParameter>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] 
[<CommonParameters>]

DownloadWafAuditLog [-Path <String>] -AuditFile <String> [-Filter <String>] [-LoadBalancer <String>] [-LBPort <Int32>] 
[-CertificateStoreLocation <String>] [-SubjectCN <String>] [-Force <SwitchParameter>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-Path false false
-AuditFile true false
-Filter false false
-LoadBalancer false false
-LBPort false false
-Credential false false
-Force false false
-InformationAction infa false false
-InformationVariable iv false false
-CertificateStoreLocation false false
-SubjectCN false false

DownloadWafCustomData

WARNING: This function is deprecated. Use the following command instead: Export-WafCustomRuleData

WARNING: This function is deprecated. Use the following command instead:
Export-WafCustomRuleData

Syntax 

DownloadWafCustomData [-Path <String>] -RuleDataName <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential 
<Object>] [-Force <SwitchParameter>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] 
[<CommonParameters>]

DownloadWafCustomData [-Path <String>] -RuleDataName <String> [-LoadBalancer <String>] [-LBPort <Int32>] 
[-CertificateStoreLocation <String>] [-SubjectCN <String>] [-Force <SwitchParameter>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-Path false false
-RuleDataName true false
-LoadBalancer false false
-LBPort false false
-Credential false false
-Force false false
-InformationAction infa false false
-InformationVariable iv false false
-CertificateStoreLocation false false
-SubjectCN false false

DownloadWafCustomRule

WARNING: This function is deprecated. Use the following command instead: Export-WafCustomRuleSet

WARNING: This function is deprecated. Use the following command instead:
Export-WafCustomRuleSet

Syntax 

DownloadWafCustomRule [-Path <String>] -RuleSetName <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential 
<Object>] [-Force <SwitchParameter>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] 
[<CommonParameters>]

DownloadWafCustomRule [-Path <String>] -RuleSetName <String> [-LoadBalancer <String>] [-LBPort <Int32>] 
[-CertificateStoreLocation <String>] [-SubjectCN <String>] [-Force <SwitchParameter>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-Path false false
-RuleSetName true false
-LoadBalancer false false
-LBPort false false
-Credential false false
-Force false false
-InformationAction infa false false
-InformationVariable iv false false
-CertificateStoreLocation false false
-SubjectCN false false

DownloadWafRules

WARNING: This function is deprecated. Use the following command instead: Update-WafRulesDatabase

WARNING: This function is deprecated. Use the following command instead:
Update-WafRulesDatabase

Syntax 

DownloadWafRules [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction <ActionPreference>] 
[-InformationVariable <String>] [<CommonParameters>]

DownloadWafRules [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN <String>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-LoadBalancer Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		 false false
-LBPort false false
-Credential The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		 false false
-InformationAction infa false false
-InformationVariable iv false false
-CertificateStoreLocation false false
-SubjectCN false false

Note

An error might be displayed, for example Command Failed: Download Failed if there is a problem downloading the rules. If there are no updates because the latest rules have already been downloaded, a message will be displayed which says No updates available.

Examples

Example 
DownloadWafRules
Example Output: Ok

Top of page

EditCustomLocation

WARNING: This function is deprecated. Use the following command instead: Set-GeoCustomLocation

WARNING: This function is deprecated. Use the following command instead:
Set-GeoCustomLocation

Syntax 

EditCustomLocation -clOldName <String> -clNewName <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential 
<Object>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

EditCustomLocation -clOldName <String> -clNewName <String> [-LoadBalancer <String>] [-LBPort <Int32>] 
[-CertificateStoreLocation <String>] [-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable 
<String>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-clOldName true false
-clNewName true false
-LoadBalancer false false
-LBPort false false
-Credential false false
-InformationAction infa false false
-InformationVariable iv false false
-CertificateStoreLocation false false
-SubjectCN false false

Enable-AdcRealServer

Enables a specified Real Server that is currently disabled.

Enables a specified Real Server that is currently disabled.

Syntax 

Enable-AdcRealServer -RSIpAddress <String> [-RSPort <Int32>] [-RSFqdn <String>] [-LoadBalancer <String>] [-LBPort <Int32>] 
[-Credential <Object>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Enable-AdcRealServer -RSIpAddress <String> [-RSPort <Int32>] [-RSFqdn <String>] [-LoadBalancer <String>] [-LBPort <Int32>] 
[-CertificateStoreLocation <String>] [-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable 
<String>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-RSIpAddress The IP address of the Real Server to enable. true false
-RSPort The port of the Real Server to enable. false false
-RSFqdn The Fully Qualified Domain Name (FQDN) of the Real Server to enable. false false
-LoadBalancer Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		 false false
-LBPort Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		 false false
-Credential The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		 false false
-InformationAction infa false false
-InformationVariable iv false false
-CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command.
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		 false false
-SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN),
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		 false false
-IPAddress The IP Address of the Real Server that should be enabled on the load balancer. This parameter is required.
The IP address can be in either the IPv4 (e.g. 10.11.0.24) or IPv6 (e.g. fdce:9b36:e54f:110::40:14) format.		 true false

Examples

Example 
Enable-AdcRealServer -RSIpAddress 10.154.11.84
Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. Data field...: @{Rs=} Param........: @{Status=Down; VSIndex=1; RsIndex=4; Addr=10.154.11.84; Port=443; DnsName=; Forward=route; Weight=1000; Limit=0; Follow=0; Enable=Y; Crit ical=N}

Top of page

Enable-ClusterNode

Enables the specified node.

Enables the specified node.

Syntax 

Enable-ClusterNode -NodeId <Int32> [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Enable-ClusterNode -NodeId <Int32> [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] 
[-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-NodeId The ID number of the node to be enabled. The ID of the node can be found in the ID column in the Cluster Control screen in
the LoadMaster WUI.		 true false
-LoadBalancer Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		 false false
-LBPort Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		 false false
-Credential The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		 false false
-InformationAction infa false false
-InformationVariable iv false false
-CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command.
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		 false false
-SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN),
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		 false false

Examples

Example 
Enable-ClusterNode -NodeId 2
Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed.

Top of page

EnableGEO

WARNING: This function is deprecated. Use the following command instead: Enable-LmGeoPack

WARNING: This function is deprecated. Use the following command instead:
Enable-LmGeoPack

Syntax 

EnableGEO [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction <ActionPreference>] 
[-InformationVariable <String>] [<CommonParameters>]

EnableGEO [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN <String>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-LoadBalancer false false
-LBPort false false
-Credential false false
-InformationAction infa false false
-InformationVariable iv false false
-CertificateStoreLocation false false
-SubjectCN false false

Enable-LmGeoPack

Enables GEO globally for the LoadMaster.

Enables GEO globally for the LoadMaster.

Syntax 

Enable-LmGeoPack [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction <ActionPreference>] 
[-InformationVariable <String>] [<CommonParameters>]

Enable-LmGeoPack [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN <String>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-LoadBalancer The IP address of the Kemp LoadMaster that you are directing the command to. This can be set globally by using the
Initialize-LoadBalancer command, but can be overridden on each individual command by using this parameter.		 false false
-LBPort The port of the load balancer. false false
-Credential Specifies a user account that has permission to administer the load balancer. You can either enter a username for the load
balancer or provide a PSCredential object, such as an object that is returned by the Get-Credential cmdlet. When you type a
username, you are prompted for a password.		 false false
-InformationAction infa false false
-InformationVariable iv false false
-CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.		 false false
-SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN),
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.		 false false

Examples

Example 
Enable-LmGeoPack
Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed.

Top of page

Enable-RealServer

WARNING: This function is deprecated. Use the following command instead: Enable-AdcRealServer

WARNING: This function is deprecated. Use the following command instead:
Enable-AdcRealServer

Syntax 

Enable-RealServer -RSIpAddress <String> [-RSPort <Int32>] [-RSFqdn <String>] [-LoadBalancer <String>] [-LBPort <Int32>] 
[-Credential <Object>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Enable-RealServer -RSIpAddress <String> [-RSPort <Int32>] [-RSFqdn <String>] [-LoadBalancer <String>] [-LBPort <Int32>] 
[-CertificateStoreLocation <String>] [-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable 
<String>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-RSIpAddress true false
-RSPort false false
-RSFqdn false false
-LoadBalancer false false
-LBPort false false
-Credential false false
-InformationAction infa false false
-InformationVariable iv false false
-CertificateStoreLocation false false
-SubjectCN false false

Enable-SecAPIAccess

Enables the programmable Application Program Interface (API).

Run this command to enable the API interface.

Syntax 

Enable-SecAPIAccess [-LBPort <Int32>] [-LoadBalancer <String>] [-Credential <Object>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Enable-SecAPIAccess [-LBPort <Int32>] [-LoadBalancer <String>] [-CertificateStoreLocation <String>] [-SubjectCN <String>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-LBPort Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		 false false
-LoadBalancer Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		 false false
-Credential The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		 false false
-InformationAction infa false false
-InformationVariable iv false false
-CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command.
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		 false false
-SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN),
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		 false false

Examples

Example 
Enable-SecAPIAccess
ReturnCode Response Data ---------- -------- ---- 200 The API is enabled

Top of page

EnableWafRemoteLogging

WARNING: This function is deprecated. Use the following command instead: Enable-WafRemoteLogging

WARNING: This function is deprecated. Use the following command instead:
Enable-WafRemoteLogging

Syntax 

EnableWafRemoteLogging -RemoteURI <String> -Username <String> -Passwd <String> [-LoadBalancer <String>] [-LBPort <Int32>] 
[-Credential <Object>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

EnableWafRemoteLogging -RemoteURI <String> -Username <String> -Passwd <String> [-LoadBalancer <String>] [-LBPort <Int32>] 
[-CertificateStoreLocation <String>] [-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable 
<String>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-RemoteURI true false
-Username true false
-Passwd true false
-LoadBalancer false false
-LBPort false false
-Credential false false
-InformationAction infa false false
-InformationVariable iv false false
-CertificateStoreLocation false false
-SubjectCN false false

Enable-WafRemoteLogging

Allows you to enable WAF remote logging.

Allows you to enable WAF remote logging.

Syntax 

Enable-WafRemoteLogging -RemoteURI <String> -Username <String> -Passwd <String> [-LoadBalancer <String>] [-LBPort <Int32>] 
[-Credential <Object>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Enable-WafRemoteLogging -RemoteURI <String> -Username <String> -Passwd <String> [-LoadBalancer <String>] [-LBPort <Int32>] 
[-CertificateStoreLocation <String>] [-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable 
<String>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-RemoteURI The remote server console URI. true false
-Username The remote username. true false
-Passwd The remote password. true false
-LoadBalancer Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		 false false
-LBPort Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		 false false
-Credential The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		 false false
-InformationAction infa false false
-InformationVariable iv false false
-CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command.
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		 false false
-SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN),
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		 false false

Examples

Example 
Enable-WafRemoteLogging -Passwd ExamplePassword -RemoteURI ExampleRemoteURI -Username ExampleUsername
Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed.

Top of page

Export-GeoIPBlacklistDatabase

Retrieve the GEO IP blacklist.

Run this command to display the current, full GEO IP blacklist.

Syntax 

Export-GeoIPBlacklistDatabase -filename <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-Force 
<SwitchParameter>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Export-GeoIPBlacklistDatabase -filename <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation 
<String>] [-SubjectCN <String>] [-Force <SwitchParameter>] [-InformationAction <ActionPreference>] [-InformationVariable 
<String>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-filename This parameter is mandatory. This is the desired path and filename for the file that will be downloaded from the
LoadMaster. If a file with the same name already exists, the command will fail. If no data is available on the LoadMaster,
the command returns an empty file.		 true false
-LoadBalancer Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		 false false
-LBPort Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		 false false
-Credential The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		 false false
-Force Enable this parameter to force the command to execute without a confirmation. false false
-InformationAction infa false false
-InformationVariable iv false false
-CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command.
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		 false false
-SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN),
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		 false false

Examples

Example 
Export-GeoIPBlacklistDatabase -filename 'C:\Users\ExampleUser\Documents\temp\blacklist.txt'
Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed.

Top of page

Export-GeoIPBlacklistDatabaseChanges

Retrieve a list of changes which were made to the blacklist.

To retrieve a list of changes which were made as of the last download, run this command.

Syntax 

Export-GeoIPBlacklistDatabaseChanges -filename <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] 
[-Force <SwitchParameter>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Export-GeoIPBlacklistDatabaseChanges -filename <String> [-LoadBalancer <String>] [-LBPort <Int32>] 
[-CertificateStoreLocation <String>] [-SubjectCN <String>] [-Force <SwitchParameter>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-filename This parameter is mandatory. This is the desired path and filename for the file that will be downloaded from the
LoadMaster. If a file with the same name already exists, the command will fail. If no data is available on the LoadMaster,
the command returns an empty file.		 true false
-LoadBalancer Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		 false false
-LBPort Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		 false false
-Credential The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		 false false
-Force Enable this parameter to force the command to execute without a confirmation. false false
-InformationAction infa false false
-InformationVariable iv false false
-CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command.
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		 false false
-SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN),
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		 false false

Examples

Example 
Export-GeoIPBlacklistDatabaseChanges -filename c:\t\example
Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed.

Top of page

Export-GeoIPWhitelistDatabase

Retrieve the contents of the user-defined whitelist.

To view the user-defined whitelist (which overrides the blacklist), run this command.

Syntax 

Export-GeoIPWhitelistDatabase -filename <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-Force 
<SwitchParameter>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Export-GeoIPWhitelistDatabase -filename <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation 
<String>] [-SubjectCN <String>] [-Force <SwitchParameter>] [-InformationAction <ActionPreference>] [-InformationVariable 
<String>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-filename This parameter is mandatory. This is the desired path and filename for the file that will be downloaded from the
LoadMaster. If a file with the same name already exists, the command will fail. If no data is available on the LoadMaster,
the command returns an empty file.		 true false
-LoadBalancer Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		 false false
-LBPort Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		 false false
-Credential The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		 false false
-Force Enable this parameter to force the command to execute without a confirmation. false false
-InformationAction infa false false
-InformationVariable iv false false
-CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command.
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		 false false
-SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN),
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		 false false

Examples

Example 
Export-GeoIPWhitelistDatabase -filename c:\t\example3
Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed.

Top of page

Export-LmExtendedLogFile

Save (download) the extended logs.

To download all extended logs, do not use the FileToExport parameter. To download specific extended logs, enter a
space-separated list of files as the FileToExport parameter.

Syntax 

Export-LmExtendedLogFile [-FileToExport <String>] [-Path <String>] [-OutputFileName <String>] [-LoadBalancer <String>] 
[-LBPort <Int32>] [-Credential <Object>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] 
[<CommonParameters>]

Export-LmExtendedLogFile [-FileToExport <String>] [-Path <String>] [-OutputFileName <String>] [-LoadBalancer <String>] 
[-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN <String>] [-InformationAction <ActionPreference>] 
[-InformationVariable <String>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-FileToExport Enter a space-separated list of files to download. For example, connection security. false false
-Path The path to download the file to. false false
-OutputFileName The name to give to the downloaded file.
The default value of the output file name LM-EspLogFile_yyyy-mm-dd_hh-mm-ss.tar.gz.		 false false
-LoadBalancer Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		 false false
-LBPort Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		 false false
-Credential The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		 false false
-InformationAction infa false false
-InformationVariable iv false false
-CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in
the specified location, for example, Cert:\&lt;CurrentUser&gt;\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command.
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		 false false
-SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN),
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		 false false

Examples

Example 
Export-LmExtendedLogFile -FileToExport "connection security" -OutputFileName logs6 -Path C:\temp\
Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed.

Top of page

Export-LmSyslogFile

Save (download) system log files.

To save (download) all system log files, run the command without the FileToExport parameter. To specify particular log
files to download, use the FileToExport parameter.

Syntax 

Export-LmSyslogFile [-FileToExport <String>] [-Path <String>] [-OutputFileName <String>] [-LoadBalancer <String>] [-LBPort 
<Int32>] [-Credential <Object>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Export-LmSyslogFile [-FileToExport <String>] [-Path <String>] [-OutputFileName <String>] [-LoadBalancer <String>] [-LBPort 
<Int32>] [-CertificateStoreLocation <String>] [-SubjectCN <String>] [-InformationAction <ActionPreference>] 
[-InformationVariable <String>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-FileToExport Enter a space-separated list of logs to save. For example, named.log warn messages.
To retrieve the names of the LoadMaster syslog files that can be entered here, run the Get-LmSyslogFie command.		 false false
-Path Enter the path to save the log file to. false false
-OutputFileName Enter the filename to give to the saved file. false false
-LoadBalancer Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		 false false
-LBPort Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		 false false
-Credential The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		 false false
-InformationAction infa false false
-InformationVariable iv false false
-CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command.
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		 false false
-SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN),
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		 false false

Examples

Example 
Export-LmSyslogFile -FileToExport "named.log warn messages" -OutputFileName logs4 -Path C:\temp\
Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed.

Top of page

Export-LmWafDebugLogs

Download the WAF debug/event logs.

This downloads a .tar.gz file.

Syntax 

Export-LmWafDebugLogs [-Path <String>] -OutputFileName <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential 
<Object>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Export-LmWafDebugLogs [-Path <String>] -OutputFileName <String> [-LoadBalancer <String>] [-LBPort <Int32>] 
[-CertificateStoreLocation <String>] [-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable 
<String>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-Path The location to download the WAF debug logs to. If the path is not specified, the file is saved by default to
C:\Windows\Temp. Ensure to add a backslash at the end of the Path string, otherwise you will receive an error,		 false false
-OutputFileName The filename to give the downloaded file. If you do not include .tar.gz at the end of the filename, the .tar.gz extension
is added to the filename.		 true false
-LoadBalancer Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		 false false
-LBPort Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		 false false
-Credential The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		 false false
-InformationAction infa false false
-InformationVariable iv false false
-CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command.
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		 false false
-SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN),
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		 false false

Examples

Example 
Export-LmWafDebugLogs -OutputFileName wafdebuglogs -Path C:\Users\ExampeUser\Downloads\
Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed.

Top of page

Export-LmWafTempRemoteLog

Parameters

Name Alias Description Required? Pipeline Input Default Value
-CertificateStoreLocation None false false
-Credential None false false
-LBPort None false false
-LoadBalancer None false false
-OutputFileName None false false
-Path None false false
-SubjectCN None false false

Export-SAMLSPCert

If using a self-signed certificate, the Export-SAMLSPCert command is used to download the certificate from the LoadMaster.

This certificate must be installed on the IdP server (for example AD FS) in order to be added to the relying party
signature.
The AD FS server will require this certificate for use of the public key in order to verify the signatures that the
LoadMaster generates.

Syntax 

Export-SAMLSPCert -Domain <String> -CertificateFilePath <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential 
<Object>] [-Force <SwitchParameter>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [-WhatIf 
<SwitchParameter>] [-Confirm <SwitchParameter>] [<CommonParameters>]

Export-SAMLSPCert -Domain <String> -CertificateFilePath <String> [-LoadBalancer <String>] [-LBPort <Int32>] 
[-CertificateStoreLocation <String>] [-SubjectCN <String>] [-Force <SwitchParameter>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [-WhatIf <SwitchParameter>] [-Confirm <SwitchParameter>] 
[<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-Domain The name of the relevant SAML SSO domain to download the certificate for. true false
-CertificateFilePath The CertificateFilePath parameter of the Export-SAMLSPCert is the name of the file where to store the certificate, not a
path. The name can be with or without the path. If no path is provided, the file is stored in current working directory. If
the file is already present the command fails. To overwrite it, the Force switch must be used.		 true false
-LoadBalancer Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		 false false
-LBPort Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		 false false
-Credential The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		 false false
-Force Enable this parameter to force the command to execute without a confirmation false false
-InformationAction infa false false
-InformationVariable iv false false
-WhatIf wi Enable this parameter to see what the command will do without actually executing the command. false false
-Confirm cf Confirms that the action should be carried out. false false
-CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command.
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		 false false
-SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN),
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		 false false

Examples

Example 
Export-SAMLSPCert -CertificateFilePath C:\ExamplePath\SAMLCert -Domain example.com
Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed.

Top of page

Export-SecUserCertificate

Download a previously generated local user certificate.

Download a previously generated local user certificate.

Syntax 

Export-SecUserCertificate -User <String> -Path <String> [-Force <SwitchParameter>] [-LoadBalancer <String>] [-LBPort 
<Int32>] [-Credential <Object>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Export-SecUserCertificate -User <String> -Path <String> [-Force <SwitchParameter>] [-LoadBalancer <String>] [-LBPort 
<Int32>] [-CertificateStoreLocation <String>] [-SubjectCN <String>] [-InformationAction <ActionPreference>] 
[-InformationVariable <String>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-User The relevant username to download the certificate for. true false
-Path The location to store the certificate file in. true false
-Force Enable this parameter to force the command to execute without a confirmation. false false
-LoadBalancer Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		 false false
-LBPort Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		 false false
-Credential The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		 false false
-InformationAction infa false false
-InformationVariable iv false false
-CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command.
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		 false false
-SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN),
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		 false false

Examples

Example 
Export-KEMPSecUserCertificate -Path c:\temp\cert -User Example
Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed.

Top of page

ExportVSTemplate

WARNING: This function is deprecated. Use the following command instead: Export-VSTemplate

WARNING: This function is deprecated. Use the following command instead:
Export-VSTemplate

Syntax 

ExportVSTemplate [-VirtualService <String>] [-Port <Int32>] [-Protocol <String>] [-VSIndex <Int32>] -Path <String> [-Force 
<SwitchParameter>] [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

ExportVSTemplate [-VirtualService <String>] [-Port <Int32>] [-Protocol <String>] [-VSIndex <Int32>] -Path <String> [-Force 
<SwitchParameter>] [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN <String>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-VirtualService Specify the IP address of the Virtual Service to be exported as a template. false false
-Port Specifies the port on which this Virtual Service accepts connections. false false
-Protocol Specifies the communication protocol of the Virtual Service. Valid options are TCP or UDP. false false
-VSIndex false false
-Path The path to the location to download the template file to, followed by the desired template file name, in the format
<Path>\<Filename>.txt.		 true false
-Force false false
-LoadBalancer Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		 false false
-LBPort Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		 false false
-Credential The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		 false false
-InformationAction infa false false
-InformationVariable iv false false
-CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command.
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		 false false
-SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN),
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		 false false

Examples

Example 
ExportVSTemplate -Path C:\Temp\ExampleTemplateName.txt -Port 80 -Protocol tcp -VirtualService 172.20.0.234
Example Output: No output is displayed, but the file should be downloaded to the specified location.

Top of page

Export-VSTemplate

Export a Virtual Service as a template.

Export the settings in a Virtual Service as a template that can be used to create other Virtual Services.

Syntax 

Export-VSTemplate [-VirtualService <String>] [-Port <Int32>] [-Protocol <String>] [-VSIndex <Int32>] -Path <String> [-Force 
<SwitchParameter>] [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Export-VSTemplate [-VirtualService <String>] [-Port <Int32>] [-Protocol <String>] [-VSIndex <Int32>] -Path <String> [-Force 
<SwitchParameter>] [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN <String>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-VirtualService The IP address of the Virtual Service to export. false false
-Port The port of the Virtual Service to export. false false
-Protocol The protocol of the Virtual Service to export. false false
-VSIndex The index number of the Virtual Service to export. To retrieve the Virtual Service index, run the Get-AdcVirtualService
command.		 false false
-Path The location to save the exported template to, in the format <path>\<filename>. true false
-Force Enable this parameter to force the command to execute without a confirmation. false false
-LoadBalancer Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		 false false
-LBPort Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		 false false
-Credential The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		 false false
-InformationAction infa false false
-InformationVariable iv false false
-CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command.
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		 false false
-SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN),
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		 false false

Examples

Example 
Export-VSTemplate -Path C:\t\template -Port 443 -Protocol tcp -VirtualService 10.154.11.181
Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed.

Top of page

Export-WafAuditLog

Allows you to download the AFP audit logs.

Allows you to download the AFP audit logs.

Syntax 

Export-WafAuditLog [-Path <String>] -AuditFile <String> [-Filter <String>] [-LoadBalancer <String>] [-LBPort <Int32>] 
[-Credential <Object>] [-Force <SwitchParameter>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] 
[<CommonParameters>]

Export-WafAuditLog [-Path <String>] -AuditFile <String> [-Filter <String>] [-LoadBalancer <String>] [-LBPort <Int32>] 
[-CertificateStoreLocation <String>] [-SubjectCN <String>] [-Force <SwitchParameter>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-Path Path to where you want to download the AFP audit logs to. You can either specify a path or a path and filename.


If the parameter Path does not contain a filename but only a path and the AuditFile parameter is not null, path will be set
to the value path/filename.


If you do not specify a path, the default path is $Env:SystemRoot\Temp\wafaudit_$(Get-Date -format
yyyy-MM-dd_HH-mm-ss).log. Usually the $Env:SystemRoot is C:\Windows. Note that the C:\Windows\Temp must exist and the user
must have write access to it in order to save the file in that folder. If not the cmdlet will fail.		 false false
-AuditFile The name of the WAF audit log file to be downloaded, for example wafaudit.1. true false
-Filter The filter string. This can be a regular expression. false false
-LoadBalancer Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		 false false
-LBPort Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		 false false
-Credential The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		 false false
-Force Enable this parameter to force the command to execute without a confirmation. false false
-InformationAction infa false false
-InformationVariable iv false false
-CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command.
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		 false false
-SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN),
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		 false false

Note

The AFP logs are not generated in real time – they can be up to two minutes behind what the AFP engine is actually processing.

Examples

Example 
Export-WafAuditLog -Path C:\WAFLogs\ExampleDesiredFileName -File wafaudit.1
Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed.

Top of page

Export-WafChangeLog

Used to download a log file containing changes made to the Kemp Web Application Firewall (WAF) rule set.

Used to download a log file containing changes made to the Kemp Web Application Firewall (WAF) rule set.

Syntax 

Export-WafChangeLog [-Path <String>] [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-Force 
<SwitchParameter>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Export-WafChangeLog [-Path <String>] [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] 
[-SubjectCN <String>] [-Force <SwitchParameter>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] 
[<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-Path The path to download the change log file to, followed by the filename and extension, in the format
<Path\Filename.Extension>.


If you do not specify a path, the default path is $Env:SystemRoot\Temp\WAF_changes_$(Get-Date -format
yyyy-MM-dd_HH-mm-ss).log. Usually the $Env:SystemRoot is C:\Windows. Note that the C:\Windows\Temp must exist and the user
must have write access to it in order to save the file in that folder. If not the cmdlet will fail.		 false false
-LoadBalancer Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		 false false
-LBPort Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		 false false
-Credential The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		 false false
-Force Enable this parameter to force the command to execute without a confirmation. false false
-InformationAction infa false false
-InformationVariable iv false false
-CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command.
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		 false false
-SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN),
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		 false false

Examples

Example 
Export-WafChangeLog -Path C:\WAFLogs\ExampleFileName.log
Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed.

Top of page

Export-WafCustomRuleData

Allows you to download an AFP custom rule data file to your local machine.

Allows you to download an AFP custom rule data file to your local machine.

Syntax 

Export-WafCustomRuleData [-Path <String>] -RuleDataName <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential 
<Object>] [-Force <SwitchParameter>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] 
[<CommonParameters>]

Export-WafCustomRuleData [-Path <String>] -RuleDataName <String> [-LoadBalancer <String>] [-LBPort <Int32>] 
[-CertificateStoreLocation <String>] [-SubjectCN <String>] [-Force <SwitchParameter>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-Path The path to download the file to. You can either specify a path or a path and filename.


If the parameter Path does not contain a filename but only a path and the RuleDataName parameter is not null, the path will
be set to the value path/RuleDataName.


If you do not specify a path, the default path is $Env:SystemRoot\Temp\WafCustomRuleData_$(Get-Date -format
yyyy-MM-dd_HH-mm-ss). Usually the $Env:SystemRoot is C:\Windows. Note that the C:\Windows\Temp must exist and the user must
have write access to it in order to save the file in that folder. If not the cmdlet will fail.		 false false
-RuleDataName The filename of the custom rule data file, followed by the extension (.data). true false
-LoadBalancer Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		 false false
-LBPort Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		 false false
-Credential The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		 false false
-Force Switch to force the command to execute without a confirmation. false false
-InformationAction infa false false
-InformationVariable iv false false
-CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command.
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		 false false
-SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN),
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		 false false

Examples

Example 
Export-WafCustomRuleData -Filename modsecurity_35_bad_robots -Path C:\rules\badrobots1
Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed.

Top of page

Export-WafCustomRuleSet

Download a Web Application Firewall (WAF) custom rule file.

Download the specified rule file to the specified path.

Syntax 

Export-WafCustomRuleSet [-Path <String>] -RuleSetName <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential 
<Object>] [-Force <SwitchParameter>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] 
[<CommonParameters>]

Export-WafCustomRuleSet [-Path <String>] -RuleSetName <String> [-LoadBalancer <String>] [-LBPort <Int32>] 
[-CertificateStoreLocation <String>] [-SubjectCN <String>] [-Force <SwitchParameter>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-Path The path to download the file to. You can either specify a path or a path and filename.


If the parameter Path does not contain a filename but only a path and the RuleDataName parameter is not null, the path will
be set to the value path/RuleDataName.


If you do not specify a path, the default path is $Env:SystemRoot\Temp\WafCustomRuleSet_$(Get-Date -format
yyyy-MM-dd_HH-mm-ss). Usually the $Env:SystemRoot is C:\Windows. Note that the C:\Windows\Temp must exist and the user must
have write access to it in order to save the file in that folder. If not the cmdlet will fail.		 false false
-RuleSetName The filename of the custom rule. true false
-LoadBalancer Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		 false false
-LBPort Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		 false false
-Credential The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		 false false
-Force Switch to force the command to execute without a confirmation. false false
-InformationAction infa false false
-InformationVariable iv false false
-CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command.
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		 false false
-SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN),
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		 false false

Examples

Example 
Export-WafCustomRuleSet -Filename modsecurity_crs_40_generic_attacks -Path C:\t\ExportedRule
Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed.

Top of page

FlushSsoCache

WARNING: This function is deprecated. Use the following command instead: Clear-SSOCache

WARNING: This function is deprecated. Use the following command instead:
Clear-SSOCache

Syntax 

FlushSsoCache [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction <ActionPreference>] 
[-InformationVariable <String>] [<CommonParameters>]

FlushSsoCache [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN <String>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-LoadBalancer false false
-LBPort false false
-Credential false false
-InformationAction infa false false
-InformationVariable iv false false
-CertificateStoreLocation false false
-SubjectCN false false

Get-AdaptiveCheck

WARNING: This function is deprecated. Use the following command instead: Get-AdcAdaptiveHealthCheck

WARNING: This function is deprecated. Use the following command instead:
Get-AdcAdaptiveHealthCheck

Syntax 

Get-AdaptiveCheck [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction <ActionPreference>] 
[-InformationVariable <String>] [<CommonParameters>]

Get-AdaptiveCheck [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN <String>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-LoadBalancer false false
-LBPort false false
-Credential false false
-InformationAction infa false false
-InformationVariable iv false false
-CertificateStoreLocation false false
-SubjectCN false false

Get-AdcAdaptiveHealthCheck

Allows you to view the values of the Adaptive Health Checking options.

Allows you to view the values of the Adaptive Health Checking options.

Syntax 

Get-AdcAdaptiveHealthCheck [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Get-AdcAdaptiveHealthCheck [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN 
<String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-LoadBalancer Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		 false false
-LBPort Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		 false false
-Credential The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		 false false
-InformationAction infa false false
-InformationVariable iv false false
-CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command.
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		 false false
-SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN),
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		 false false

Examples

Example 
Get-AdcAdaptiveHealthCheck
Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. AdaptiveURL : /load AdaptivePort : 80 AdaptiveInterval : 7 MinPercent : 5

Top of page

Get-AdcContentRule

Returns configured rules on the LoadMaster and the values of the associated options.

Returns configured rules on the LoadMaster and the values of the associated options. You can specify all the configured
rules, a specific rule or rules of a specific type.

Syntax 

Get-AdcContentRule [-RuleName <String>] [-RuleType <String>] [-All <SwitchParameter>] [-LoadBalancer <String>] [-LBPort 
<Int32>] [-Credential <Object>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Get-AdcContentRule [-RuleName <String>] [-RuleType <String>] [-All <SwitchParameter>] [-LoadBalancer <String>] [-LBPort 
<Int32>] [-CertificateStoreLocation <String>] [-SubjectCN <String>] [-InformationAction <ActionPreference>] 
[-InformationVariable <String>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-RuleName Specifies the name of the rule to retrieve. false false
-RuleType Specifies the type of rule to retrieve from the LoadMaster.
Options are:
- MatchContentRule
- AddHeaderRule
- DeleteHeaderRule
- ReplaceHeaderRule
- ModifyURLRule		 false false
-All Gets all rules defined on the LoadMaster. false false
-LoadBalancer Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		 false false
-LBPort Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		 false false
-Credential The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		 false false
-InformationAction infa false false
-InformationVariable iv false false
-CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command.
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		 false false
-SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN),
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		 false false

Examples

Example 
Get-AdcContentRule -Type MatchContentRule
Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. Data field...: @{ContentRules=} Param........: @{MatchContentRule=} MatchContentRule : @{Name=Example3; Pattern=ExamplePattern2; MatchType=Regex; AddHost=N; Negate=N; CaseIndependent=N; IncludeQuery=N; Header=; MustFail=N}

Top of page

Get-AdcL7Configuration

Allows you to view the values of Layer 7 Configuration options.

Allows you to view the values of Layer 7 Configuration options.

Syntax 

Get-AdcL7Configuration [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Get-AdcL7Configuration [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN 
<String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-LoadBalancer Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		 false false
-LBPort Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		 false false
-Credential The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		 false false
-InformationAction infa false false
-InformationVariable iv false false
-CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command.
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		 false false
-SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN),
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		 false false

Examples

Example 
Get-AdcL7Configuration -LoadBalancer 172.21.59.189 -LBPort 8443
Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed; Data=} Return Code..: 200 Response.....: Command successfully executed Data field...: @{AdcL7Configuration=} Param........: @{ScalingOver64KConnections=no; AlwaysCheckPersist=Yes - Accept Changes; AddPortToActiveCookie=no; RFCConform=yes; CloseOnError=no; AddVi aHeaderInCacheResponses=no; RSAreLocal=no; DropOnRSFail=no; DropAtDrainEnd=no; L7AuthTimeoutSecs=30; L7ClientTokenTimeoutSecs=120; L7ConnectionDrainTime outSecs=300; AdditionalL7Header=X-ClientSide; OneHundredContinueHandling=RFC-2616 Compliant; AllowEmptyPosts=no; AllowEmptyHttpHeaders=no; ForceComplete RSMatch=no; SlowStart=0; ShareSubVSPersistance=no} ScalingOver64KConnections : no AlwaysCheckPersist : Yes - Accept Changes AddPortToActiveCookie : no RFCConform : yes CloseOnError : no AddViaHeaderInCacheResponses : no RSAreLocal : no DropOnRSFail : no DropAtDrainEnd : no L7AuthTimeoutSecs : 30 L7ClientTokenTimeoutSecs : 120 L7ConnectionDrainTimeoutSecs : 300 AdditionalL7Header : X-ClientSide OneHundredContinueHandling : RFC-2616 Compliant AllowEmptyPosts : no AllowEmptyHttpHeaders : no ForceCompleteRSMatch : no SlowStart : 0 ShareSubVSPersistance : no

Top of page

Get-AdcL7LogInsightSplitConfiguration

Displays the log split interval value.

Displays the log split interval value.

Syntax 

Get-AdcL7LogInsightSplitConfiguration [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Get-AdcL7LogInsightSplitConfiguration [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] 
[-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-LoadBalancer Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		 false false
-LBPort Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		 false false
-Credential The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		 false false
-InformationAction infa false false
-InformationVariable iv false false
-CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command.
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		 false false
-SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN),
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		 false false

Examples

Example 
Get-AdcL7LogInsightSplitConfiguration
Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed; Data=} Return Code..: 200 Response.....: Command successfully executed Data field...: @{AdcL7Configuration=} Param........: @{ScalingOver64KConnections=no; AlwaysCheckPersist=Yes - Accept Changes; AddPortToActiveCookie=no; RFCConform=yes; CloseOnError=no; AddVi aHeaderInCacheResponses=no; RSAreLocal=no; DropOnRSFail=no; DropAtDrainEnd=no; L7AuthTimeoutSecs=30; L7ClientTokenTimeoutSecs=120; L7ConnectionDrainTime outSecs=300; AdditionalL7Header=X-ClientSide; OneHundredContinueHandling=RFC-2616 Compliant; AllowEmptyPosts=no; AllowEmptyHttpHeaders=no; ForceComplete RSMatch=no; SlowStart=0; ShareSubVSPersistance=no} ScalingOver64KConnections : no AlwaysCheckPersist : Yes - Accept Changes AddPortToActiveCookie : no RFCConform : yes CloseOnError : no AddViaHeaderInCacheResponses : no RSAreLocal : no DropOnRSFail : no DropAtDrainEnd : no L7AuthTimeoutSecs : 30 L7ClientTokenTimeoutSecs : 120 L7ConnectionDrainTimeoutSecs : 300 AdditionalL7Header : X-ClientSide OneHundredContinueHandling : RFC-2616 Compliant AllowEmptyPosts : no AllowEmptyHttpHeaders : no ForceCompleteRSMatch : no SlowStart : 0 ShareSubVSPersistance : no

Top of page

Get-AdcRealServer

Returns a list of all Real Servers and their settings.

Returns a list of all Real Servers and their settings.

Syntax 

Get-AdcRealServer [-VirtualService <String>] [-VSPort <Int32>] [-VSProtocol <String>] [-VSIndex <Int32>] [-RealServer 
<String>] [-RSPort <Int32>] [-RSIndex <Int32>] [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Get-AdcRealServer [-VirtualService <String>] [-VSPort <Int32>] [-VSProtocol <String>] [-VSIndex <Int32>] [-RealServer 
<String>] [-RSPort <Int32>] [-RSIndex <Int32>] [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation 
<String>] [-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-VirtualService The address of the relevant Virtual Service. false false
-VSPort The port of the relevant Virtual Service. false false
-VSProtocol The protocol of the relevant Virtual Service. false false
-VSIndex The ID number of the relevant Virtual Service. false false
-RealServer The address of the relevant Real Server, if retrieving details about a particular Real Server. false false
-RSPort The port number of the relevant Real Server, if retrieving details about a particular Real Server. false false
-RSIndex The ID number of the relevant Real Server, if retrieving details about a particular Real Server. false false
-LoadBalancer Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		 false false
-LBPort Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		 false false
-Credential The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		 false false
-InformationAction infa false false
-InformationVariable iv false false
-CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command.
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		 false false
-SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN),
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		 false false

Examples

Example 
Get-AdcRealServer -VirtualService 10.154.11.181 -VSPort 443 -VSProtocol tcp
Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. Data field...: @{Rs=} Param........: @{Status=Down; VSIndex=1; RsIndex=4; Addr=10.154.11.84; Port=443; DnsName=; Forward=route; Weight=1000; Limit=0; Follow=0; Enable=Y; Crit ical=N}

Top of page

Get-AdcServiceHealth

Allows you to see the values of the Service Check options.

Allows you to see the values of the Service Check options.

Syntax 

Get-AdcServiceHealth [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Get-AdcServiceHealth [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN <String>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-LoadBalancer Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		 false false
-LBPort Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		 false false
-Credential The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		 false false
-InformationAction infa false false
-InformationVariable iv false false
-CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command.
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		 false false
-SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN),
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		 false false

Examples

Example 
Get-AdcServiceHealth
Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. Data field...: @{AdcServiceHealth=} CheckInterval : 9 ConnectionTimeout : 4 RetryCount : 2

Top of page

Get-AdcSubVirtualService

Retrieve details for a SubVS.

This command returns details of the specified SubVS.

Syntax 

Get-AdcSubVirtualService -SubVSIndex <Int32> [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Get-AdcSubVirtualService -SubVSIndex <Int32> [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation 
<String>] [-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-SubVSIndex The ID number of the SubVS to retrieve details for. true false
-LoadBalancer Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		 false false
-LBPort Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		 false false
-Credential The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		 false false
-InformationAction infa false false
-InformationVariable iv false false
-CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command.
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		 false false
-SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN),
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		 false false

Examples

Example 
Get-AdcSubVirtualService
Example: Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. Data field...: @{VS=} Param........: @{Status=Down; Index=3; VSPort=0; Layer=7; Enable=Y; SSLReverse=N; SSLReencrypt=N; Intercept=N; InterceptOpts=; AlertThreshold=0; Transac tionlimit=0; Transparent=N; SubnetOriginating=Y; ServerInit=0; StartTLSMode=0; Idletime=660; Cache=N; Compress=N; Verify=0; UseforSnat=N; ForceL4=N; For ceL7=Y; MultiConnect=N; ClientCert=0; ErrorCode=0; CheckUse1.1=N; MatchLen=0; CheckUseGet=0; SSLRewrite=0; VStype=http; FollowVSID=0; Protocol=tcp; Sche dule=rr; CheckType=http; PersistTimeout=0; CheckPort=0; NRules=0; NRequestRules=0; NResponseRules=0; NPreProcessRules=0; EspEnabled=N; InputAuthMode=0; OutputAuthMode=0; MasterVS=0; MasterVSID=1; IsTransparent=2; AddVia=0; QoS=0; TlsType=0; NeedHostName=N; OCSPVerify=N; AllowHTTP2=N; EnhancedHealthCheck s=N; RsMinimum=0; NumberOfRSs=0}

Top of page

Get-AdcTotalVirtualService

Retrieve details about the Virtual Services, SubVSs and Real Servers.

This command returns the total number of Virtual Services, SubVSs and Real Servers and also returns the total number of
each that are up, down and disabled.

Syntax 

Get-AdcTotalVirtualService [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Get-AdcTotalVirtualService [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN 
<String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-LoadBalancer Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		 false false
-LBPort Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		 false false
-Credential The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		 false false
-InformationAction infa false false
-InformationVariable iv false false
-CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command.
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		 false false
-SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN),
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		 false false

Examples

Example 
Get-AdcTotalVirtualService
Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. VSTotals : @{Total=6; Up=2; Down=4; Disabled=0} SUBVSTotals : @{Total=32; Up=0; Down=32; Disabled=0} RSTotals : @{Total=1; Up=0; Down=0; Disabled=1}

Top of page

Get-AdcVirtualService

Get details for configured Virtual Services.

Returns details of all Virtual Services on the LoadMaster. If details of a specific Virtual Service are entered in the
parameters, only details relating to that Virtual Service will be displayed.

Syntax 

Get-AdcVirtualService [-VirtualService <String>] [-VSPort <Int32>] [-VSProtocol <String>] [-VSIndex <Int32>] [-LoadBalancer 
<String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] 
[<CommonParameters>]

Get-AdcVirtualService [-VirtualService <String>] [-VSPort <Int32>] [-VSProtocol <String>] [-VSIndex <Int32>] [-LoadBalancer 
<String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN <String>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-VirtualService The IP address of the Virtual Service to be displayed. false false
-VSPort The port of the Virtual Service to retrieve the details for. false false
-VSProtocol The protocol of the Virtual Service to retrieve the details for. false false
-VSIndex The index number of the Virtual Service to be displayed. false false
-LoadBalancer Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		 false false
-LBPort Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		 false false
-Credential The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		 false false
-InformationAction infa false false
-InformationVariable iv false false
-CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command.
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		 false false
-SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN),
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		 false false
-Port The port of the Virtual Service to be displayed. false false
-Protocol The protocol of the Virtual Service to be displayed. false false

Examples

Example 
Get-AdcVirtualService
Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. Data field...: @{Status=Down; Index=4; VSAddress=10.154.11.90; VSPort=80; Layer=7; Enable=Y; SSLReverse=N; SSLReencrypt=N; Intercept=N; InterceptOpts=; AlertThreshold=0; Transactionlimit=0; Transparent=N; SubnetOriginating=Y; ServerInit=0; StartTLSMode=0; Idletime=660; Cache=N; Compress=N; Verify=0; Use forSnat=N; ForceL4=N; ForceL7=Y; MultiConnect=N; ClientCert=0; ErrorCode=0; CheckUse1.1=N; MatchLen=0; CheckUseGet=0; SSLRewrite=0; VStype=http; FollowV SID=0; Protocol=tcp; Schedule=rr; CheckType=http; PersistTimeout=0; CheckPort=0; NRules=0; NRequestRules=0; NResponseRules=0; NPreProcessRules=0; EspEna bled=N; InputAuthMode=0; OutputAuthMode=0; MasterVS=0; MasterVSID=0; IsTransparent=2; AddVia=0; QoS=0; TlsType=0; NeedHostName=N; OCSPVerify=N; AllowHTT P2=N; EnhancedHealthChecks=N; RsMinimum=0; NumberOfRSs=0} Param........: @{Status=Down; Index=4; VSAddress=10.154.11.90; VSPort=80; Layer=7; Enable=Y; SSLReverse=N; SSLReencrypt=N; Intercept=N; InterceptOpts=; AlertThreshold=0; Transactionlimit=0; Transparent=N; SubnetOriginating=Y; ServerInit=0; StartTLSMode=0; Idletime=660; Cache=N; Compress=N; Verify=0; Use forSnat=N; ForceL4=N; ForceL7=Y; MultiConnect=N; ClientCert=0; ErrorCode=0; CheckUse1.1=N; MatchLen=0; CheckUseGet=0; SSLRewrite=0; VStype=http; FollowV SID=0; Protocol=tcp; Schedule=rr; CheckType=http; PersistTimeout=0; CheckPort=0; NRules=0; NRequestRules=0; NResponseRules=0; NPreProcessRules=0; EspEna bled=N; InputAuthMode=0; OutputAuthMode=0; MasterVS=0; MasterVSID=0; IsTransparent=2; AddVia=0; QoS=0; TlsType=0; NeedHostName=N; OCSPVerify=N; AllowHTT P2=N; EnhancedHealthChecks=N; RsMinimum=0; NumberOfRSs=0} Status : Down Index : 4 VSAddress : 10.154.11.90 VSPort : 80 Layer : 7 Enable : Y SSLReverse : N SSLReencrypt : N Intercept : N InterceptOpts : @{Opt=System.Object[]} AlertThreshold : 0 Transactionlimit : 0 Transparent : N SubnetOriginating : Y ServerInit : 0 StartTLSMode : 0 Idletime : 660 Cache : N Compress : N Verify : 0 UseforSnat : N ForceL4 : N ForceL7 : Y MultiConnect : N ClientCert : 0 ErrorCode : 0 CheckUse1.1 : N MatchLen : 0 CheckUseGet : 0 SSLRewrite : 0 VStype : http FollowVSID : 0 Protocol : tcp Schedule : rr CheckType : http PersistTimeout : 0 CheckPort : 0 NRules : 0 NRequestRules : 0 NResponseRules : 0 NPreProcessRules : 0 EspEnabled : N InputAuthMode : 0 OutputAuthMode : 0 MasterVS : 0 MasterVSID : 0 IsTransparent : 2 AddVia : 0 QoS : 0 TlsType : 0 NeedHostName : N OCSPVerify : N AllowHTTP2 : N EnhancedHealthChecks : N RsMinimum : 0 NumberOfRSs : 0

Top of page

Get-AdcVsWafRule

Retrieve the status of a Web Application Firewall (WAF) rule.

This command shows if the specified WAF rule is active/inactive.

Syntax 

Get-AdcVsWafRule -VS <String> -VSPort <String> -VSProtocol <String> -Rule <String> [-LoadBalancer <String>] [-LBPort 
<Int32>] [-Credential <Object>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Get-AdcVsWafRule -VS <String> -VSPort <String> -VSProtocol <String> -Rule <String> [-LoadBalancer <String>] [-LBPort 
<Int32>] [-CertificateStoreLocation <String>] [-SubjectCN <String>] [-InformationAction <ActionPreference>] 
[-InformationVariable <String>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-VS The address of the relevant Virtual Service. true false
-VSPort The port of the relevant Virtual Service. true false
-VSProtocol The port of the relevant Virtual Service. true false
-Rule The <RuleName> must be preceded with the relevant letter or word and a forward slash. The letter/word used depends on the
type of rule being checked:
C or Custom
Z or ApplicationGeneric
A or ApplicationSpecific
G or Generic


This is case sensitive. The letter/word needs to be in in the correct case for the command to work.		 true false
-LoadBalancer Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		 false false
-LBPort Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		 false false
-Credential The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		 false false
-InformationAction infa false false
-InformationVariable iv false false
-CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command.
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		 false false
-SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN),
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		 false false

Examples

Example 
Get-AdcVsWafRule -Rule G/ip_reputation -VS 10.35.47.16 -VSPort 80 -VSProtocol tcp
Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. ip_reputation : Inactive

Top of page

Get-AFEConfiguration

WARNING: This function is deprecated. Use the following command instead: Get-LmAFEConfiguration

WARNING: This function is deprecated. Use the following command instead:
Get-LmAFEConfiguration

Syntax 

Get-AFEConfiguration [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Get-AFEConfiguration [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN <String>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-LoadBalancer false false
-LBPort false false
-Credential false false
-InformationAction infa false false
-InformationVariable iv false false
-CertificateStoreLocation false false
-SubjectCN false false

Get-AllParameters

WARNING: This function is deprecated. Use the following command instead: Get-LmAllParameters

WARNING: This function is deprecated. Use the following command instead:
Get-LmAllParameters

Syntax 

Get-AllParameters [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction <ActionPreference>] 
[-InformationVariable <String>] [<CommonParameters>]

Get-AllParameters [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN <String>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-LoadBalancer Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		 false false
-LBPort Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		 false false
-Credential The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		 false false
-InformationAction infa false false
-InformationVariable iv false false
-CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command.
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		 false false
-SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN),
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		 false false

Examples

Example 
Get-AllParameters
Example Output: dfltgw : 172.20.0.1 snat : no hamode : 0 sshaccess : yes sshport : 22 wuiaccess : yes wuiiface : 0 wuiport : 443 sshiface : all hoverhelp : yes routefilter : no transparent : no expect100 : 0 localbind : no addcookieport : no subnetoriginating : yes nonlocalrs : no multigw : no addforwardheader : 0 conntimeout : 660 authtimeout : 30 finalpersist : 300 tcptimestamp : no paranoia : 1 cachesize : 100 hostcache : no resetclose : no rfcconform : yes keepalive : yes backupday : 0 backupenable : no backuphour : 0 backupminute : 0 backuppassword : ******** enableapi : yes emailpassword : ******** emailsslmode : 0 emailport : 0 addvia : no allowupload : no dropatdrainend : no droponfail : no closeonerror : no limitinput : 0 rsarelocal : no slowstart : 0 subnetorigin : yes syslogcritical : 10.35.0.190 syslogemergency : 10.35.0.190 syslogerror : 10.35.0.190 sysloginfo : 10.35.0.190 syslognotice : 10.35.0.190 syslogwarn : 10.35.0.190 sslrenegotiate : no dnssecclient : yes emailenable : no irqbalance : no snmpenable : no snmpV3enable : no snmpv3userpasswd : ******** snmpHaTrap : no snmptrapenable : no motd : <h1>This device is being managed by Kemp 360</h1> wuidisplaylines : 0 linearesplogs : no onlydefaultroutes : no sessionauthmode : 0 sessionidletime : 0 sessionmaxfailattempts : 0 sessioncontrol : no sessionbasicauth : yes sessionconcurrent : 0 adminclientaccess : 0 sessionlocalauth : no ntpkeyid : 0 ntpkeysecret : ******** netconsoleinterface : 0 namserver : 10.154.11.192 radiusbackupport : 0 radiusbackupsecret : ******** radiusport : 0 radiussecret : ******** radiusrevalidateinterval : 60 ldapsecurity : 0 ldaprevalidateinterval : 60 geosshport : 22 hostname : lb100 admincert : No Admin Certificate assigned localcert : Only available in HA mode time : Tue, 15 Mar 16 15:08:38 UTC serialnumber : 1051082 version : 7.1.35.0.12508.DEV Tethering : yes multihomedwui : no logsplitinterval : 10 allowemptyposts : no OCSPPort : 0 OCSPUseSSL : no OCSPOnServerFail : no L7LimitInput : 0 sdnstatsmode : 0 dhkeysize : 2048 WUITLSProtocols : 0 WUICipherset : Intermediate_compatibility

Top of page

Get-AslLicenseType

Retrieve a list of available license types.

Retrieve a list of available license types when using local licensing functionality.

Syntax 

Get-AslLicenseType [-aslhost <String>] [-aslport <Int32>] [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Get-AslLicenseType [-aslhost <String>] [-aslport <Int32>] [-LoadBalancer <String>] [-LBPort <Int32>] 
[-CertificateStoreLocation <String>] [-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable 
<String>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-aslhost Specify the Kemp 360 Central Host or IP address. false false
-aslport Specify the port of the Kemp 360 Central machine being used to activate the license. false false
-LoadBalancer Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		 false false
-LBPort Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		 false false
-Credential The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		 false false
-InformationAction infa false false
-InformationVariable iv false false
-CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command.
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		 false false
-SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN),
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		 false false
-aslipaddr false false
-aslname false false

Note

The aslhost parameter was introduced in LoadMaster firmware version 7.2.43. The parameters previously used were called aslipaddr and aslname. If you have scripts using these old parameters, you will need to update them to use the new aslhost parameter if upgrading.

Examples

Example 
Get-AslLicenseType -LoadBalancer 10.35.41.63 -Verbose -aslhost 10.35.41.53 -aslport 443
Example Output: Full response: Command successfully executed. Return Code..: 200 Response.....: Command successfully executed Data field...: @{OrderID=; AvailableLicenses=1; Licenses=} Param........: id : 0be64d5fb077d757c691e6745cf68c6c035e9635 name : VLM-5000 ESP GEO with Evaluation + WAF description : VLM-5000 ESP GEO with Evaluation + WAF available : 1 tethered : False

Top of page

Get-AwsHAOption

WARNING: This function is deprecated. Use the following command instead: Get-LmAwsHAConfiguration

WARNING: This function is deprecated. Use the following command instead:
Get-LmAwsHAConfiguration

Syntax 

Get-AwsHAOption [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction <ActionPreference>] 
[-InformationVariable <String>] [<CommonParameters>]

Get-AwsHAOption [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN <String>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-LoadBalancer Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		 false false
-LBPort false false
-Credential The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		 false false
-InformationAction infa false false
-InformationVariable iv false false
-CertificateStoreLocation false false
-SubjectCN false false

Examples

Example 
Get-AwsHAOption
Example Output: AwsHA master,192.168.1.1,8443

Top of page

Get-AzureHAOption

WARNING: This function is deprecated. Use the following command instead: Get-LmAzureHAConfiguration

WARNING: This function is deprecated. Use the following command instead:
Get-LmAzureHAConfiguration

Syntax 

Get-AzureHAOption [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction <ActionPreference>] 
[-InformationVariable <String>] [<CommonParameters>]

Get-AzureHAOption [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN <String>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-LoadBalancer Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		 false false
-LBPort false false
-Credential The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		 false false
-InformationAction infa false false
-InformationVariable iv false false
-CertificateStoreLocation false false
-SubjectCN false false

Examples

Example 
Get-AzureHAOption
Example Output: (This is a legacy command and has been replaced with the Get-ClusterAzureHAConfiguration command.)

Top of page

Get-BackupOption

WARNING: This function is deprecated. Use the following command instead: Get-LmBackupConfiguration

WARNING: This function is deprecated. Use the following command instead:
Get-LmBackupConfiguration

Syntax 

Get-BackupOption [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction <ActionPreference>] 
[-InformationVariable <String>] [<CommonParameters>]

Get-BackupOption [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN <String>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-LoadBalancer false false
-LBPort false false
-Credential false false
-InformationAction infa false false
-InformationVariable iv false false
-CertificateStoreLocation false false
-SubjectCN false false

GetCipherset

WARNING: This function is deprecated. Use the following command instead: Get-TlsCipherSet

WARNING: This function is deprecated. Use the following command instead:
Get-TlsCipherSet

Syntax 

GetCipherset -Name <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

GetCipherset -Name <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN 
<String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-Name true false
-LoadBalancer false false
-LBPort false false
-Credential false false
-InformationAction infa false false
-InformationVariable iv false false
-CertificateStoreLocation false false
-SubjectCN false false

Get-ClusterStatus

Retrieves the status of the cluster.

Retrieves the status of the cluster.

Syntax 

Get-ClusterStatus [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction <ActionPreference>] 
[-InformationVariable <String>] [<CommonParameters>]

Get-ClusterStatus [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN <String>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-LoadBalancer Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		 false false
-LBPort Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		 false false
-Credential The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		 false false
-InformationAction infa false false
-InformationVariable iv false false
-CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command.
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		 false false
-SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN),
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		 false false

Examples

Example 
Get-ClusterStatus
Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. {SharedAddress=172.16.178.178; Node=System.Object[]} $get.Data.ClusterConfiguration SharedAddress Node ------------- ---- 172.16.178.178 {@ {Id=1; Address=172.16.176.1; Enabled=1; Status=5} , @ {Id=2; Address=172.16.178.1; Enabled=0; Status=2} , @{Id=3; Add... $get.Data.ClusterConfiguration.Node Id Address Enabled Status – ------- ------- ------ 1 172.16.176.1 1 5 2 172.16.178.1 0 2 3 172.16.191.1 0 2 $get.Data.ClusterConfiguration.SharedAddress 172.16.178.178

Top of page

Get-DateTimeOption

WARNING: This function is deprecated. Use the following command instead: Get-LmDateTimeConfiguration

WARNING: This function is deprecated. Use the following command instead:
Get-LmDateTimeConfiguration

Syntax 

Get-DateTimeOption [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Get-DateTimeOption [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN <String>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-LoadBalancer false false
-LBPort false false
-Credential false false
-InformationAction infa false false
-InformationVariable iv false false
-CertificateStoreLocation false false
-SubjectCN false false

Get-DebugOption

WARNING: This function is deprecated. Use the following command instead: Get-LmDebugConfiguration

WARNING: This function is deprecated. Use the following command instead:
Get-LmDebugConfiguration

Syntax 

Get-DebugOption [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction <ActionPreference>] 
[-InformationVariable <String>] [<CommonParameters>]

Get-DebugOption [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN <String>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-LoadBalancer false false
-LBPort false false
-Credential false false
-InformationAction infa false false
-InformationVariable iv false false
-CertificateStoreLocation false false
-SubjectCN false false

Get-DNSConfiguration

WARNING: This function is deprecated. Use the following command instead: Get-NetworkDNSConfiguration

WARNING: This function is deprecated. Use the following command instead:
Get-NetworkDNSConfiguration

Syntax 

Get-DNSConfiguration [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Get-DNSConfiguration [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN <String>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-LoadBalancer false false
-LBPort false false
-Credential false false
-InformationAction infa false false
-InformationVariable iv false false
-CertificateStoreLocation false false
-SubjectCN false false

Get-EmailOption

WARNING: This function is deprecated. Use the following command instead: Get-LogEmailConfiguration

WARNING: This function is deprecated. Use the following command instead:
Get-LogEmailConfiguration

Syntax 

Get-EmailOption [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction <ActionPreference>] 
[-InformationVariable <String>] [<CommonParameters>]

Get-EmailOption [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN <String>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-LoadBalancer false false
-LBPort false false
-Credential false false
-InformationAction infa false false
-InformationVariable iv false false
-CertificateStoreLocation false false
-SubjectCN false false

Get-EspExtendedLogConfiguration

Check if extended Edge Security Pack (ESP) logging is currently enabled/disabled.

Check if extended ESP logging is currently enabled/disabled.

Syntax 

Get-EspExtendedLogConfiguration [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Get-EspExtendedLogConfiguration [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN 
<String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-LoadBalancer Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		 false false
-LBPort Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		 false false
-Credential The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		 false false
-InformationAction infa false false
-InformationVariable iv false false
-CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command.
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		 false false
-SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN),
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		 false false

Examples

Example 
Get-EspExtendedLogConfiguration
Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=ExtEspLogStatus=disabled} Return Code..: 200 Response.....: Command successfully executed. ExtEspLogStatus --------------- disabled

Top of page

Get-GeoCluster

Display all GEO clusters, or one specific GEO cluster.

Run this command without the IP parameter to display all all clusters. Specify an IP address in order to display details
for one specific cluster.

Syntax 

Get-GeoCluster [-ClusterIp <String>] [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Get-GeoCluster [-ClusterIp <String>] [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] 
[-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-ClusterIp The IP address of the cluster to retrieve. false false
-LoadBalancer Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		 false false
-LBPort Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		 false false
-Credential The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		 false false
-InformationAction infa false false
-InformationVariable iv false false
-CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command.
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		 false false
-SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN),
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		 false false
-IP To display details for one particular GEO cluster, specify the IP address of the cluster using this parameter. false false

Examples

Example 
Get-GeoCluster -ClusterIp 10.34.52.55
Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. Index : 1 Status : Up Name : ExampleCluster ClusterVSAddress : IPAddress : 10.34.52.55 Checker : none CheckerPort : 80 Type : default Enable : Y LocationLatitude : LocationLongitude :
Example 2 

							    
$lma = Get-GeoCluster -ClusterIp 172.16.0.63 -LoadBalancer 172.16.0.59 -Credential bal

$lma

ReturnCode Response                       Data          
---------- --------                       ----          
       200 Command successfully executed. @{GeoCluster=}



$lma.Data.GeoCluster


Index             : 7
Status            : Up
Name              : RemoteLM_172.16.0.63
ClusterVSAddress  : @{Address=System.Object[]; RemoteVS=System.Object[]}
IPAddress         : 172.16.0.63
Checker           : none
CheckerPort       : 80
Type              : remoteLM
Enable            : Y
LocationLatitude  : 
LocationLongitude : 




$lma.Data.GeoCluster.ClusterVSAddress

Address                                                      RemoteVS                                                       
                                                  
-------                                                      --------                                                       
                                                  
{172.16.0.63, 172.16.0.63:8844, 172.16.0.64, 172.16.0.64:22} {@{Address=172.16.0.63}, @{Address=172.16.0.63; Port=8844; 
Name=LocalVS_01}, @{Address=172.16.0.64}, @{Address...



$lma.Data.GeoCluster.ClusterVSAddress.RemoteVS | Format-List


Address : 172.16.0.63

Address : 172.16.0.63
Port    : 8844
Name    : LocalVS_01

Address : 172.16.0.64

Address : 172.16.0.64
Port    : 22
Name    : LocalVS_02




$lma.Data.GeoCluster.ClusterVSAddress.RemoteVS[0].Address
172.16.0.63

$lma.Data.GeoCluster.ClusterVSAddress.RemoteVS[1]

Address     Port Name      
-------     ---- ----      
172.16.0.63 8844 LocalVS_01



$lma.Data.GeoCluster.ClusterVSAddress.RemoteVS[1].Address
172.16.0.63

$lma.Data.GeoCluster.ClusterVSAddress.RemoteVS[1].Name
LocalVS_01

$lma.Data.GeoCluster.ClusterVSAddress.RemoteVS[1].Port
8844

                            

						

                        
Top of page
				

				

					

						
 Get-GeoCustomLocation 

						
Retrieves a list of any existing custom locations.

						
Retrieves a list of any existing custom locations.

					

                        

                        
 Syntax 

                        

						

                            


Get-GeoCustomLocation [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Get-GeoCustomLocation [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN <String>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Get-GeoCustomLocation

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.
Name : Limerick

                            

						

                        
Top of page
				

				

					

						
 Get-GeoDNSSECConfiguration 

						
Retrieve the DNSSEC settings.

						
Retrieve the DNSSEC settings.

					

                        

                        
 Syntax 

                        

						

                            


Get-GeoDNSSECConfiguration [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Get-GeoDNSSECConfiguration [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN 
<String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Get-GeoDNSSECConfiguration

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.

PublicKey                                                                                                                   
                          
---------                                                                                                                   
                          
ExampleZone. IN DNSKEY 257 3 8 AwEAAeRfz2/QoPCphUgG2nK/DK8u8xxbseh64lDRydZHbGRTM8XjXd6v 
+lt9peqGFqulejJe0ojI0KrBVZqwkPkEuwujqL+zaYG6/SfW0xRdzEdP SF...

                            

						

                        
Top of page
				

				

					

						
 Get-GeoFQDN 

						
Display settings for either all FQDNs, or a specific FQDN.

						
Set the FQDN parameter to display details for a specific FQDN. To display details for all FQDNs, do not use the FQDN 
parameter.

					

                        

                        
 Syntax 

                        

						

                            


Get-GeoFQDN [-FQDN <String>] [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Get-GeoFQDN [-FQDN <String>] [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN 
<String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-FQDN
                                        
										To display details for a specific FQDN - specify the name of the FQDN using this parameter.
										false
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Get-GeoFQDN -FQDN Example.com

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.
SelectionCriteria : RoundRobin
SiteRecoveryMode  : auto
Mapping           : 0
LocalSettings     : 0
UnanimousChecks   : N
Failover          : N
SiteFailureDelay  : 0
Fqdn              : Example.com.
PrivateRequest    : 0
PublicRequest     : 0

							    Example 2


							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.
Status        : Down
Index         : 3
IPAddress     : 1.1.1.1
Cluster       : RemoteLM
Checker       : clust
CheckerPort   : 0
Weight        : 1000
MappedAddress : 172.16.193.254
MappedPort    : 80
MappedName    : MY VS_1
Enable        : Y

                            

						

                        
Top of page
				

				

					

						
 Get-GeoIPBlacklistDatabaseConfiguration 

						
Retrieve the GEO IP blacklist settings.

						
Run this command to retrieve the GEO IP blacklist settings, such as the:
- Date of the last update
- Date of the last install
- Auto-update setting
- Auto-install settings

					

                        

                        
 Syntax 

                        

						

                            


Get-GeoIPBlacklistDatabaseConfiguration [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Get-GeoIPBlacklistDatabaseConfiguration [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] 
[-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Get-GeoIPBlacklistDatabaseConfiguration

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.


AutoUpdate      : yes
LastUpdated     : 03 May 2017 14:55:09
AutoInstall     : no
InstallTimeHour : 4
LastInstalled   : 03 May 2017 14:55:19

                            

						

                        
Top of page
				

				

					

						
 Get-GeoIpRange 

						
Displays details of all IP ranges, or one specific IP range.

						
To retrieve details for a specific IP range, set the IP parameter. To retrieve details for all IP ranges, do not use the IP 
parameter.

					

                        

                        
 Syntax 

                        

						

                            


Get-GeoIpRange [-IP <String>] [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Get-GeoIpRange [-IP <String>] [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN 
<String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-IP
                                        
										Specify the IP address of the range to display details for. Do not use this parameter if you want to retrieve details for 
all IP ranges.		
										false
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Get-GeoIpRange

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.
Index     : 1
Ip        : 10.154.11.55
IPAddress : 10.154.11.55
Mask      : 32
Country   : 
IsCustom  : N

                            

						

                        
Top of page
				

				

					

						
 Get-GeoIPWhitelist 

						
Retrieve the contents of the user-defined GEO IP whitelist.

						
The whitelist overrides the blacklist.

					

                        

                        
 Syntax 

                        

						

                            


Get-GeoIPWhitelist [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Get-GeoIPWhitelist [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN <String>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Get-GeoMiscParameter

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.
Data field...: @{GeoWhiteList=}
Param........: @{addr=System.Object[]}

addr                            
----                            
{20.54.56.26/32, 12.45.54.33/32}

                            

						

                        
Top of page
				

				

					

						
 Get-GeoMiscParameter 

						
Displays the values of the miscellaneous GEO parameters.

						
Shows settings relating to Source of Authority, Resource Check Parameters and Stickiness.

					

                        

                        
 Syntax 

                        

						

                            


Get-GeoMiscParameter [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Get-GeoMiscParameter [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN <String>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Get-GeoMiscParameter

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.
soa   : @{TTL=10; persist=60; Zone=; SourceOfAuthority=; NameSrv=; SOAEmail=}
check : @{CheckInterval=120; ConnTimeout=20; RetryAttempts=2}

                            

						

                        
Top of page
				

				

					

						
 Get-GeoPartnerStatus 

						
Returns the status of all configured GEO partners.

						
The status returned is either:
 - Up
 - Down
- Empty: An empty list is returned if there are no GEO partners configured.
 - Unknown: If a status for a particular partner is not known

					

                        

                        
 Syntax 

                        

						

                            


Get-GeoPartnerStatus [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Get-GeoPartnerStatus [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN <String>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Get-GeoPartnerStatus

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.
Address : 10.154.11.180
Status  : Down

                            

						

                        
Top of page
				

				

					

						
 Get-GeoStatistics 

						
Retrieve the Global Server Load Balancing (GSLB) statistics.

						
Get statistics relating to GSLB service status, FQDNs, queries, and DNS request information.

					

                        

                        
 Syntax 

                        

						

                            


Get-GeoStatistics [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction <ActionPreference>] 
[-InformationVariable <String>] [<CommonParameters>]

Get-GeoStatistics [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN <String>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Get-GeoStatistics

							    
Example Output:
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=@{GeoStats=}}
Return Code..: 200
Response.....: Command successfully executed.
Data field...: @{GSLBServiceStatus=; FQDNStatistics=}
Param........:
GSLBServiceStatus                                                                                                           
                     FQDNStatistics         
-----------------                                                                                                           
                          --------------         
@{BootTime=Tue, 14 Feb 2017 12:10:10 GMT; LastConfiguration=Fri, 30 Jun 2017 08:40:48 GMT}  @{FQDN=System.Object[]}

                            

						

                        
Top of page
				

				

					

						
 Get-GlobalPacketFilterACL 

						
Displays the addresses on the global black or white list.

						
Lists the host and network IP addresses on the global black or white access control list. Note that black and white lists 
are only enabled when packet filtering is enabled.

					

                        

                        
 Syntax 

                        

						

                            


Get-GlobalPacketFilterACL -Type <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Get-GlobalPacketFilterACL -Type <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] 
[-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-Type
                                        
										Specifies the access control list type:  "black" or "white".
										true
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Get-GlobalPacketFilterACL -Type black

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.
Data field...: @{Blacklist=}
Param........: @{addr=10.154.11.12/32; comment=Example comment}

                            

						

                        
Top of page
				

				

					

						
 Get-HAOption 

						
WARNING: This function is deprecated. Use the following command instead:
Get-LmHAConfiguration

						
WARNING: This function is deprecated. Use the following command instead:
Get-LmHAConfiguration

					

                        

                        
 Syntax 

                        

						

                            


Get-HAOption [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction <ActionPreference>] 
[-InformationVariable <String>] [<CommonParameters>]

Get-HAOption [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN <String>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-LoadBalancer
                                        
										
										false
										false
										
									

									

										-LBPort
                                        
										
										false
										false
										
									

									

										-Credential
                                        
										
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										
										false
										false
										
									

									

										-SubjectCN
                                        
										
										false
										false
										
									

								
							

						
				
				

				

					

						
 Get-HostsEntry 

						
Lists the existing hosts for local resolution.

						
This command returns a list of host IP addresses and host FQDNs for local resolution.

					

                        

                        
 Syntax 

                        

						

                            


Get-HostsEntry [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction <ActionPreference>] 
[-InformationVariable <String>] [<CommonParameters>]

Get-HostsEntry [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN <String>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Get-HostsEntry

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.
Data field...: @{LocalHosts=}
Param........: @{HostIPAddress=10.154.33.233; HostFqdn=example.com}
HostIPAddress : 10.154.33.233
HostFqdn      : example.com

                            

						

                        
Top of page
				

				

					

						
 Get-Interface 

						
WARNING: This function is deprecated. Use the following command instead:
Get-NetworkInterface

						
WARNING: This function is deprecated. Use the following command instead:
Get-NetworkInterface

					

                        

                        
 Syntax 

                        

						

                            


Get-Interface [-InterfaceID <Int16>] [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Get-Interface [-InterfaceID <Int16>] [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] 
[-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-InterfaceID
                                        
										
										false
										false
										
									

									

										-LoadBalancer
                                        
										
										false
										false
										
									

									

										-LBPort
                                        
										
										false
										false
										
									

									

										-Credential
                                        
										
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										
										false
										false
										
									

									

										-SubjectCN
                                        
										
										false
										false
										
									

								
							

						
				
				

				

					

						
 Get-L7Configuration 

						
WARNING: This function is deprecated. Use the following command instead:
Get-AdcL7Configuration

						
WARNING: This function is deprecated. Use the following command instead:
Get-AdcL7Configuration

					

                        

                        
 Syntax 

                        

						

                            


Get-L7Configuration [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Get-L7Configuration [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN <String>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-LoadBalancer
                                        
										
										false
										false
										
									

									

										-LBPort
                                        
										
										false
										false
										
									

									

										-Credential
                                        
										
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										
										false
										false
										
									

									

										-SubjectCN
                                        
										
										false
										false
										
									

								
							

						
				
				

				

					

						
 Get-LdapEndpoint 

						
Retrieve details for existing LDAP endpoints.

						
If you do not specify a value in the name parameter the output will display details of all existing endpoints. Specify a 
name to retreive details for that specific LDAP endpoint.

					

                        

                        
 Syntax 

                        

						

                            


Get-LdapEndpoint [-Name <String>] [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Get-LdapEndpoint [-Name <String>] [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] 
[-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-Name
                                        
										The name of the LDAP endpoint to retreive details for.
										false
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Get-LdapEndpoint

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.
Data field...: @{LDAPEndPoint=System.Object[]}
Param........:  


name          : EXAMPLE
vinterval     : 60
server        : 10.154.11.103 10.154.11.104
adminuser     : ExampleUser
adminpass     : ********
LdapProtocol  : Unencrypted
ReferralCount : 6

name          : EXAMPLE2
vinterval     : 60
server        : 10.154.11.32
adminuser     : exampleuser
adminpass     : ********
LdapProtocol  : StartTLS
ReferralCount : 0

                            

						

                        
Top of page
				

				

					

						
 Get-LicenseAccessKey 

						
Allows you to get the access key of the LoadMaster.

						
Allows you to get the access key of the LoadMaster.

					

                        

                        
 Syntax 

                        

						

                            


Get-LicenseAccessKey [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Get-LicenseAccessKey [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN <String>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Get-LicenseAccessKey

							    
Example Output:
Full response: Command successfully executed.
Return Code..: 200
Response.....: Command successfully executed
Data field...: @{AccessKey=mmw14-97w51-cr45g-88x5g}

                            

						

                        
Top of page
				

				

					

						
 Get-LicenseInfo 

						
Retrieves the license details for the LoadMaster.

						
Retrieves the license details for the LoadMaster.

					

                        

                        
 Syntax 

                        

						

                            


Get-LicenseInfo [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction <ActionPreference>] 
[-InformationVariable <String>] [<CommonParameters>]

Get-LicenseInfo [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN <String>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

$get = Get-LicenseInfo -Credential bal -LoadBalancer 10.154.11.180

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.
Data field...: @{LicenseInfo=}
Param........: @{uuid=31159ab6-5da4-4b92-8ee2-b8922cc08dfe; ActivationDate=Tue Nov 15 10:32:34 UTC 2016; 
LicensedUntil=unlimited; SupportLevel=; Support
Until=none; LicenseType=; LicenseStatus=Single Perm; ApplianceModel=; MaxVS=0; MaxRS=0; Bandwidth=5000; TpsLimit=10000; 
HA=no; FirstHA=no; ModSecurity=n
o; AFE=yes; ViewAFE=yes; ESP=yes; IPSEC=0; SingleCPU=no; VLM=no; FreeLicense=no; Temporary=no; ASL=no; MandatoryTether=no; 
MultipleConnect=no}


uuid            : 31159ab6-5da4-4b92-8ee2-b8922cc08dfe
ActivationDate  : Tue Nov 15 10:32:34 UTC 2016
LicensedUntil   : unlimited
SupportLevel    : 
SupportUntil    : none
LicenseType     : 
LicenseStatus   : Single Perm
ApplianceModel  : 
MaxVS           : 0
MaxRS           : 0
Bandwidth       : 5000
TpsLimit        : 10000
HA              : no
FirstHA         : no
ModSecurity     : no
AFE             : yes
ViewAFE         : yes
ESP             : yes
IPSEC           : 0
SingleCPU       : no
VLM             : no
FreeLicense     : no
Temporary       : no
ASL             : no
MandatoryTether : no
MultipleConnect : no

                            

						

                        
Top of page
				

				

					

						
 Get-LicenseType 

						
Retrieve a list of available license types for a particular Kemp ID.

						
If successful, the output provides a list of license types and associated IDs. The ID number is used when licensing using 
the Request-LicenseOnline command.

					

                        

                        
 Syntax 

                        

						

                            


Get-LicenseType -KempId <String> -Password <String> [-OrderId <String>] [-http_proxy <String>] [-LoadBalancer <String>] 
[-LBPort <Int32>] [-Credential <Object>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] 
[<CommonParameters>]

Get-LicenseType -KempId <String> -Password <String> [-OrderId <String>] [-http_proxy <String>] [-LoadBalancer <String>] 
[-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN <String>] [-InformationAction <ActionPreference>] 
[-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-KempId
                                        
										The Kemp ID (email address) to retrieve the license types for.
										true
										false
										
									

									

										-Password
                                        
										The password for the Kemp ID being used.
										true
										false
										
									

									

										-OrderId
                                        
										The Orderid parameter is only needed for Virtual LoadMasters. The Order ID is provided by Kemp after a license is purchased.
										false
										false
										
									

									

										-http_proxy
                                        
										Specify the HTTP(S) proxy server and port, in the format <ProxyAddress>:<Port>.
										false
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username used to connect to the LoadMaster.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Get-LicenseType -KempId jbloggs@kemptechnologies.com -Password ExamplePassword -LoadBalancer 172.16.129.72 -Credential bal

							    
Example Output:

Full response: Command successfully executed.
Return Code..: 200
Response.....: Command successfully executed
Data field...: @{name=VLM-5000 with Enterprise Plus subscription; available=1; tethered=0; 
id=69cc7829c122f7a1604d97c5224c56f596b4f718; LicenseSt...
Param........:
name : VLM-5000 with Enterprise Plus subscription
available : 1
tethered : 0
id : 69cc7829c122f7a1604d97c5224c56f596b4f718
LicenseStatus : Temp License
description : VLM-5000 with Enterprise Plus subscription
BuyMoreAt : https://www.kemptechnologies.com/buy-me-now?KempID=jbloggs@kemptechnologies.com

							    Example (with Order ID)

Get-LicenseType -KempId jbloggs@kemptechnologies.com -Password ExamplePassword -LoadBalancer 172.16.129.72 -Credential bal -OrderId ExampleOrderID

							    
Example Output:
Full response: Command successfully executed.
Return Code..: 200
Response.....: Command successfully executed
Data field...: @{id=2010d06f77b2d646677b1fd0b4688c019b66ddb7; name=VLM-200 with Enterprise Plus subscription; available=1; 
description=VLM-200 wi...
Param........:
id : 2010d06f77b2d646677b1fd0b4688c019b66ddb7
name : VLM-200 with Enterprise Plus subscription
available : 1
description : VLM-200 with Enterprise Plus subscription
tethered : False
LicenseStatus : Permanent License
BuyMoreAt : https://www.kemptechnologies.com/buy-me-now?KempID=jbloggs@kemptechnologies.com
id : b2eb3e9260958b57743fd1a2cf704915754085b7
name : VLM-2000 with Enterprise Plus subscription
available : 1
description : VLM-2000 with Enterprise Plus subscription
tethered : False
LicenseStatus : Permanent License
BuyMoreAt : https://www.kemptechnologies.com/buy-me-now?KempID=jbloggs@kemptechnologies.com
id : be9fbc4ca4f0f5e023809aa4fc7b399ed7bd0d76
name : VLM-GEO with Enterprise Plus subscription
available : 1
description : VLM-GEO with Enterprise Plus subscription
tethered : False
LicenseStatus : Permanent License
BuyMoreAt : https://www.kemptechnologies.com/buy-me-now?KempID=jbloggs@kemptechnologies.com
name : VLM-5000 with Enterprise Plus subscription
available : 1
tethered : 0
id : 69cc7829c122f7a1604d97c5224c56f596b4f718
LicenseStatus : Temp License
description : VLM-5000 with Enterprise Plus subscription
BuyMoreAt : https://www.kemptechnologies.com/buy-me-now?KempID=jbloggs@kemptechnologies.com

                            

						

                        
Top of page
				

				

					

						
 Get-LmAddOn 

						
Displays a list of any add-on packages that are installed on the LoadMaster.

						
Displays a list of any add-on packages that are installed on the LoadMaster.

					

                        

                        
 Syntax 

                        

						

                            


Get-LmAddOn [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction <ActionPreference>] 
[-InformationVariable <String>] [<CommonParameters>]

Get-LmAddOn [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN <String>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Get-LmAddOn

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.
Data field...: @{Package=}
Param........: 

Name     Installed                Version            Started
----     ---------                -------            -------
Vmtoolsd Thu Sep 15 05:58:56 2016 7.2.37.0.13719.DEV yes

                            

						

                        
Top of page
				

				

					

						
 Get-LmAFEConfiguration 

						
Allows you to view the values of Cache, Compression and IPS options.

						
Allows you to view the values of Cache, Compression and IPS options.

					

                        

                        
 Syntax 

                        

						

                            


Get-LmAFEConfiguration [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Get-LmAFEConfiguration [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN 
<String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite 
it.ster that you are directing the command to. This can be set globally by using the Initialize-LoadBalancer command, but 
can be overridden on each individual command by using this parameter.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Get-LmAFEConfiguration

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.

Cachesize HostCache LimitInput DetectionLevel                               
--------- --------- ---------- --------------                               
100       no        0          Default

                            

						

                        
Top of page
				

				

					

						
 Get-LmAllParameters 

						
Retrieve a list of all parameters that can be retrieved using the Get-LmParameter command.

						
Retrieve a list of all parameters that can be retrieved using the Get-LmParameter command and set using the Set-LmParameter 
command.

					

                        

                        
 Syntax 

                        

						

                            


Get-LmAllParameters [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Get-LmAllParameters [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN <String>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-LoadBalancer
                                        
										The IP address of the Kemp LoadMaster that you are directing the command to. This can be set globally by using the 
Initialize-LoadBalancer command, but can be overridden on each individual command by using this parameter.		
										false
										false
										
									

									

										-LBPort
                                        
										The port of the load balancer.
										false
										false
										
									

									

										-Credential
                                        
										Specifies a user account that has permission to administer the load balancer. You can either enter a username for the load 
balancer or provide a PSCredential object, such as an object that is returned by the Get-Credential cmdlet. When you type a 
username, you are prompted for a password.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

$get = Get-LmAllParameters

$get

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.
Data field...: @{AllParameters=}
Param........: 


dfltgw                 : 10.154.0.1
snat                   : yes
hatimeout              : 1
hawait                 : 0
haprefered             : 0
hamode                 : 1
hastatus               : standby
haif                   : 0
havhid                 : 0
hainitial              : no
tcpfailover            : no
cookieupdate           : no
hal4update             : no
hal7update             : no
vmac                   : no
sshaccess              : yes
sshport                : 22
wuiaccess              : yes
mcast                  : 0
wuiiface               : 0
wuiport                : 443
sshiface               : all
hoverhelp              : yes
routefilter            : no
transparent            : no
alwayspersist          : 2
expect100              : 0
localbind              : no
addcookieport          : no
subnetoriginating      : yes
nonlocalrs             : no
multigw                : no
addforwardheader       : 0
conntimeout            : 660
authtimeout            : 30
clienttokentimeout     : 120
finalpersist           : 300
tcptimestamp           : no
paranoia               : 1
cachesize              : 100
hostcache              : no
resetclose             : no
rfcconform             : yes
keepalive              : yes
backupday              : 0
backupenable           : yes
backuphour             : 0
backupminute           : 0
backuppassword         : ********
backupnetstat          : yes
backupsecure           : yes
backupident            : ********
enableapi              : yes
emailuser              : test
emaildomain            : ExampleDomain
emailpassword          : ********
emailserver            : 10.154.22.132
emailsslmode           : 1
emailport              : 80
addvia                 : no
allowupload            : no
dropatdrainend         : no
droponfail             : no
closeonerror           : no
limitinput             : 0
rsarelocal             : no
slowstart              : 0
subnetorigin           : yes
sysloginfo             : 10.154.153.94
sslrenegotiate         : no
dnssecclient           : yes
emailenable            : yes
irqbalance             : no
snmpenable             : yes
snmpV3enable           : no
snmpv3userpasswd       : ********
snmpHaTrap             : no
snmptrapenable         : no
motd                   : &lt;h1&gt;This device is being managed by Kemp 360&lt;/h1&gt;
wuidisplaylines        : 0
linearesplogs          : no
onlydefaultroutes      : no
sessionauthmode        : 19
sessionidletime        : 0
sessionmaxfailattempts : 0
sessioncontrol         : yes
sessionbasicauth       : no
sessionconcurrent      : 0
adminclientaccess      : 1
sessionlocalauth       : no
ntpkeyid               : 0
ntpkeysecret           : ********
netconsoleinterface    : 0
nameserver             : 10.154.75.25
namserver              : 10.154.75.25
wuildapep              : EXAMPLE
geopartners            : 10.154.11.190
geosshport             : 22
geosshiface            : 0
hostname               : lb100
searchlist             :  Kemp.LAB.INTRA
admincert              : No Admin Certificate assigned
localcert              : No Local Admin Certificate assigned
time                   : Thu, 20 Apr 17 10:14:21 UTC
boottime               : Tue, 11 Apr 17 13:36:17 UTC
activetime             : Thu, 01 Jan 70 00:00:00 UTC
serialnumber           : 446312
version                : 7.2.39.0.14938.DEV
Tethering              : yes
multihomedwui          : no
logsplitinterval       : 10
allowemptyposts        : no
OCSPPort               : 0
OCSPUseSSL             : no
OCSPOnServerFail       : no
L7LimitInput           : 0
sdnstatsmode           : 0
dhkeysize              : 2048
WUITLSProtocols        : 0
AllowEmptyHttpHeaders  : no
ShareSubVSPersist      : no
DNSNamesEnable         : yes
ForceFullRSMatch       : no
SSLForceServerVerify   : no
SyslogPort             : 60
SSLStapling            : no
SSLRefreshInterval     : 3700

                            

						

                        
Top of page
				

				

					

						
 Get-LmAwsHAConfiguration 

						
Retrieve the AWS High Availability (HA) parameters.

						
Display the HA settings for a LoadMaster on Azure.

					

                        

                        
 Syntax 

                        

						

                            


Get-LmAwsHAConfiguration [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Get-LmAwsHAConfiguration [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN 
<String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Get-LmAwsHAConfiguration

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed; Data=}
Return Code..: 200
Response.....: Command successfully executed
Data field...: @{AwsHAConfiguration=}

HaMode Partner HealthCheckPort 
------ ------- ---------------
single unset   unset

                            

						

                        
Top of page
				

				

					

						
 Get-LmAzureHAConfiguration 

						
Retrieves the Azure High Availability (HA) parameters.

						
Displays the HA settings for an Azure LoadMaster.

					

                        

                        
 Syntax 

                        

						

                            


Get-LmAzureHAConfiguration [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Get-LmAzureHAConfiguration [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN 
<String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Get-LmAzureHAConfiguration

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed; Data=}
Return Code..: 200
Response.....: Command successfully executed
Data field...: @{AzureHAConfiguration=}

HaMode Partner HealthCheckPort 
------ ------- --------------- 
single unset   unset

                            

						

                        
Top of page
				

				

					

						
 Get-LmBackupConfiguration 

						
Allows to view the values of the Automated Backup options.

						
Allows to view the values of the Automated Backup options.

					

                        

                        
 Syntax 

                        

						

                            


Get-LmBackupConfiguration [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Get-LmBackupConfiguration [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN 
<String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Get-LmBackupConfiguration

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed; Data=}
Return Code..: 200
Response.....: Command successfully executed
Data field...: @{BackupConfiguration=}
Param........: @{backupenable=yes; backuphour=0; backupminute=0; backupday=0; BackupMethod=SCP; backupuser=; 
backuppassword=********; backuphost=; back
uppath=}


backupenable   : yes
backuphour     : 0
backupminute   : 0
backupday      : 0
BackupMethod   : SCP
backupuser     : 
backuppassword : ********
backuphost     : 
backuppath     :

                            

						

                        
Top of page
				

				

					

						
 Get-LmCloudHaConfiguration 

						
Retrieve the High Availability (HA) parameters for a cloud LoadMaster.

						
Retrieve details such as the HA mode and partner IP address.

					

                        

                        
 Syntax 

                        

						

                            


Get-LmCloudHaConfiguration [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Get-LmCloudHaConfiguration [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN 
<String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Get-LmCloudHaConfiguration

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed; Data=}
Return Code..: 200
Response.....: Command successfully executed
Data field...: @{CloudHAConfiguration=}
Param........: @{HaMode=master; Partner=10.121.11.17; HealthCheckAllInterfaces=no; HealthCheckPort=8444; Hapreferred=0}

HaMode                   : master
Partner                  : 10.121.11.17
HealthCheckAllInterfaces : no
HealthCheckPort          : 8444
Hapreferred              : 0

                            

						

                        
Top of page
				

				

					

						
 Get-LmDateTimeConfiguration 

						
Allows you to view the values of the Date and Time options.

						
Allows you to view the values of the Date and Time options.

					

                        

                        
 Syntax 

                        

						

                            


Get-LmDateTimeConfiguration [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Get-LmDateTimeConfiguration [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN 
<String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
						

                            

                                
 Note 

                            

							
This is a legacy command and does not return all of the available parameters. Please refer to the Get-Help of the 
    Get-Parameter command to view a full list of parameters that can be returned.

						

                        

                            
 Examples 

                        

						

                            

							    Example

Get-LmDateTimeConfiguration

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed; Data=}
Return Code..: 200
Response.....: Command successfully executed
Data field...: @{DateTimeConfiguration=}
Param........: @{NTPHost=; Time=Thu, 20 Apr 17 11:12:59 UTC; BootTime=Thu, 20 Apr 17 11:02:28 UTC; ActiveTime=Thu, 20 Apr 
17 11:02:28 UTC; TimeZone=; NT
PKeyId=0}

                            

						

                        
Top of page
				

				

					

						
 Get-LmDebugConfiguration 

						
Displays the Debug Option values.

						
Allows you to view some of the values of options contained in the in the Debug Option screen of the WUI.

					

                        

                        
 Syntax 

                        

						

                            


Get-LmDebugConfiguration [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Get-LmDebugConfiguration [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN 
<String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Get-LmDebugConfiguration

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.

irqbalance          : no
linearesplogs       : no
netconsole          : 
netconsoleinterface : 0

                            

						

                        
Top of page
				

				

					

						
 Get-LmDebugInformation 

						
Returns the system information related to the specified command option.

						
Returns the system information related to the specified command option.

					

                        

                        
 Syntax 

                        

						

                            


Get-LmDebugInformation [-Param <String>] [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Get-LmDebugInformation [-Param <String>] [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] 
[-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-Param
                                        
										Valid values and their descriptions are provided below:
 - ps: Report a snapshot of the current processes.
 - meminfo: Report the memory status of the LoadMaster.
 - ifconfig: Return the details of the network interfaces.
 - netstat: Return the following information:
                - Active Internet connections, servers and established (IPv4/IPv6)
                - Kernel IP routing table (IPv4/IPv6)
                - IPv4/IPv6 packet filter
 - interrupts: Lists the number of interrupts per CPU per I/O device.
 - partitions: Partition block allocation information.
 - cpuinfo: Return the details of the LoadMaster CPU(s).
 - df: Display the device name, total blocks, total disk space, used disk space, available disk space and mount points on 
the LoadMaster file system.
 - lspci: Returns information about PCI buses in the system and devices connected to them.
 - lsmod: Show the status of modules in the Linux Kernel
 - slabinfo: Return statistics for frequently used objects in the Linux kernel (buffer heads, inodes, dentries and so on).		
										false
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Get-LmDebugInformation -Param ps

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.

F   UID   PID  PPID PRI  NI    VSZ   RSS WCHAN  STAT TTY        TIME COMMAND
4     0     1     0  20   0   4356  1376 -      Ss   ?          0:14 init [2]  
1     0     2     0  20   0      0     0 -      S    ?          0:00 [kthreadd]
1     0     3     2  20   0      0     0 -      S    ?          0:01 [ksoftirqd/0]
1     0     4     2  20   0      0     0 -      S    ?          0:00 [kworker/0:0]
1     0     5     2   0 -20      0     0 -      S<   ?          0:00 [kworker/0:0H]
1     0     7     2  20   0      0     0 -      S    ?          1:28 [rcu_sched]
1     0     8     2  20   0      0     0 -      S    ?          0:00 [rcu_bh]
1     0     9     2 -100  -      0     0 -      S    ?          0:04 [migration/0]
5     0    10     2 -100  -      0     0 -      S    ?          0:04 [watchdog/0]
5     0    11     2 -100  -      0     0 -      S    ?          0:05 [watchdog/1]
1     0    12     2 -100  -      0     0 -      S    ?          0:04 [migration/1]
1     0    13     2  20   0      0     0 -      S    ?          0:02 [ksoftirqd/1]
1     0    15     2   0 -20      0     0 -      S<   ?          0:00 [kworker/1:0H]
1     0    16     2   0 -20      0     0 -      S<   ?          0:00 [netns]
1     0    17     2   0 -20      0     0 -      S<   ?          0:00 [perf]
1     0    18     2  20   0      0     0 -      S    ?          0:02 [khungtaskd]
1     0    19     2   0 -20      0     0 -      S<   ?          0:00 [writeback]
1     0    20     2   0 -20      0     0 -      S<   ?          0:00 [crypto]
1     0    21     2  20   0      0     0 -      S    ?          1:30 [kworker/0:1]
1     0    22     2   0 -20      0     0 -      S<   ?          0:00 [bioset]
1     0    23     2   0 -20      0     0 -      S<   ?          0:00 [kblockd]
1     0    24     2   0 -20      0     0 -      S<   ?          0:00 [ata_sff]
1     0    26     2  20   0      0     0 -      S    ?          0:00 [kswapd0]
1     0    27     2   0 -20      0     0 -      S<   ?          0:00 [vmstat]
1     0    28     2  20   0      0     0 -      S    ?          0:00 [fsnotify_mark]
1     0    43     2   0 -20      0     0 -      S<   ?          0:00 [acpi_thermal_pm]
1     0    45     2   0 -20      0     0 -      S<   ?          0:00 [bioset]
1     0    46     2   0 -20      0     0 -      S<   ?          0:00 [bioset]
1     0    47     2   0 -20      0     0 -      S<   ?          0:00 [bioset]
1     0    48     2   0 -20      0     0 -      S<   ?          0:00 [bioset]
1     0    49     2   0 -20      0     0 -      S<   ?          0:00 [bioset]
1     0    50     2   0 -20      0     0 -      S<   ?          0:00 [bioset]
1     0    51     2   0 -20      0     0 -      S<   ?          0:00 [bioset]
1     0    52     2   0 -20      0     0 -      S<   ?          0:00 [bioset]
1     0    53     2   0 -20      0     0 -      S<   ?          0:00 [bioset]
1     0    54     2   0 -20      0     0 -      S<   ?          0:00 [bioset]
1     0    55     2   0 -20      0     0 -      S<   ?          0:00 [bioset]
1     0    56     2   0 -20      0     0 -      S<   ?          0:00 [bioset]
1     0    57     2   0 -20      0     0 -      S<   ?          0:00 [bioset]
1     0    58     2   0 -20      0     0 -      S<   ?          0:00 [bioset]
1     0    59     2   0 -20      0     0 -      S<   ?          0:00 [bioset]
1     0    60     2   0 -20      0     0 -      S<   ?          0:00 [bioset]
1     0    61     2   0 -20      0     0 -      S<   ?          0:00 [bioset]
1     0    62     2   0 -20      0     0 -      S<   ?          0:00 [bioset]
1     0    63     2   0 -20      0     0 -      S<   ?          0:00 [bioset]
1     0    64     2   0 -20      0     0 -      S<   ?          0:00 [bioset]
1     0    65     2   0 -20      0     0 -      S<   ?          0:00 [bioset]
1     0    66     2  20   0      0     0 -      S    ?          0:48 [kworker/1:1]
1     0    67     2   0 -20      0     0 -      S<   ?          0:00 [bioset]
1     0    68     2   0 -20      0     0 -      S<   ?          0:00 [bioset]
1     0    69     2   0 -20      0     0 -      S<   ?          0:00 [bioset]
1     0    70     2   0 -20      0     0 -      S<   ?          0:00 [fc_exch_workque]
1     0    71     2   0 -20      0     0 -      S<   ?          0:00 [fc_rport_eq]
1     0    72     2   0 -20      0     0 -      S<   ?          0:00 [fcoethread/0]
1     0    73     2   0 -20      0     0 -      S<   ?          0:00 [fcoethread/1]
1     0    74     2   0 -20      0     0 -      S<   ?          0:00 [fnic_event_wq]
1     0    75     2   0 -20      0     0 -      S<   ?          0:00 [fnic_fip_q]
1     0    76     2  20   0      0     0 -      S    ?          0:00 [scsi_eh_0]
1     0    77     2   0 -20      0     0 -      S<   ?          0:00 [scsi_tmf_0]
1     0    78     2   0 -20      0     0 -      S<   ?          0:00 [vmw_pvscsi_wq_0]
1     0    79     2   0 -20      0     0 -      S<   ?          0:00 [bioset]
1     0    95     2   0 -20      0     0 -      S<   ?          0:00 [kpsmoused]
1     0    96     2  20   0      0     0 -      S    ?          0:00 [kworker/1:2]
1     0    97     2   0 -20      0     0 -      S<   ?          0:00 [ipv6_addrconf]
1     0    98     2   0 -20      0     0 -      S<   ?          0:00 [deferwq]
1     0    99     2   0 -20      0     0 -      S<   ?          0:00 [ext4-rsv-conver]
1     0   142     2   0 -20      0     0 -      S<   ?          0:00 [kworker/0:1H]
5     3   261     1  20   0  26816  1444 -      Ss   ?          0:09 /sbin/nscd
1     0   279     2   0 -20      0     0 -      S<   ?          0:00 [kworker/1:1H]
1     0   297     2   0 -20      0     0 -      S<   ?          0:00 [loop0]
5     0   636     1  20   0   4392  1780 -      Ss   ?          0:09 /usr/sbin/syslogd
5     0   640     1  20   0   4488  1372 -      Ss   ?          0:00 /usr/sbin/klogd -c 7
4     0   668     1  20   0  18488  4612 -      Ss   ?          0:00 /usr/sbin/sshd
1     0   677     1  20   0  15228  1564 -      Ss   ?          0:04 /usr/sbin/cron -L 0
1     0   692     2   0 -20      0     0 -      S<   ?          0:00 [l7comp]
4     0   727     1  20   0   4464  1904 -      S    ?          0:20 /sbin/l7d -C 0 -N 0 -0 eth0 -G 1 -T 2 -l
0     0   729     1  20   0   4196   644 -      S    ?          0:02 /sbin/l7log
0     0   732     1  20   0   9536  2660 -      S    ?          0:00 /bin/bash /sbin/startDaemon /sbin/ssomgr -C 0
0     0   761     1  20   0   9536  2648 -      S    ?          0:00 /bin/bash /sbin/startDaemon /sbin/stats -C 0
4     0   767   761  20   0  11688  1896 -      S    ?          3:11 /sbin/stats -C 0
0     0   784     1  20   0  11868  4984 -      S    ?         26:01 /bin/bash /usr/local/bin/rrd-upd-all.sh
1     0   793     1  20   0   6508   124 -      S    ?          0:40 inotifywait -d -o/tmp/metrics.evts -e MOVED_TO 
--format %T %f %e --timefmt %s /var/
lib/metrics
0     0   833     1  20   0   9536  2636 -      S    ?          0:00 /bin/bash /sbin/startDaemon /sbin/ocspd
4     0   842   833  20   0  14060  3576 -      S    ?          0:03 /sbin/ocspd
0     0   860     1  20   0   6728  1668 -      S    ?          0:02 /sbin/httpd -port 8080 -address 127.0.0.1
0     0   907     1  20   0   9540  2660 -      S    ?          0:00 /bin/bash /sbin/startDaemon /sbin/wafd -C 0 -M 4
4     0   916   907  20   0  52488  4212 -      S    ?          0:00 /sbin/wafd -C 0 -M 4
0     0   949     1  20   0   9536  2656 -      S    ?          0:00 /bin/bash /sbin/startDaemon /sbin/l4d -C 0
4     0   957   949  12  -8  17520  3252 -      S<   ?          0:35 /sbin/l4d -C 0
0     0  1000     1  20   0   4672  1304 -      S    ?          0:04 /sbin/binddb -C 0
0     0  1002     1  20   0   5440   704 -      S    ?          0:13 /sbin/geocheck -C 0
4     0  1004   732  20   0  50372  6324 -      S    ?          0:12 /sbin/ssomgr -C 0
5     0  1008     1  20   0  66652 50156 -      Ss   ?          0:10 /sbin/named
4     0  1045     1  20   0 116464  4184 -      Sl   ?         13:51 /usr/bin/vmtoolsd
4     0  1078     1  20   0   8680  1648 -      Ss+  tty1       0:00 /sbin/mingetty --noclear tty1
4     0  1079     1  20   0   8680  1652 -      Ss+  tty2       0:00 /sbin/mingetty tty2
4     0  1080     1  20   0   8680  1656 -      Ss+  tty3       0:00 /sbin/mingetty tty3
4     0  1081     1  20   0   8680  1724 -      Ss+  tty4       0:00 /sbin/mingetty tty4
4     0  1082     1  20   0   8680  1652 -      Ss+  tty5       0:00 /sbin/mingetty tty5
4     0  1083     1  20   0   8680  1672 -      Ss+  tty6       0:00 /sbin/mingetty tty6
4     0  1084     1  20   0   4360  1660 -      Ss+  ttyS0      0:00 /sbin/agetty -L -f /etc/issue.serial 115200 57600 
38400 19200 9600 ttyS0 vt100
1     0  1272     2  20   0      0     0 -      S    ?          0:00 [kworker/u4:2]
5     0  1304   916  20   0  59144  6192 -      Sl   ?          0:00 /sbin/wafd -C 0 -M 4
0     0  1356     1  20   0   9540  2664 -      S    ?          0:00 /bin/bash /sbin/startDaemon /sbin/sslproxy -T 10 -P 
443 -r 127.0.0.1:8080 -F IPADDR
_0 -F ADDITIONAL_0 -c /one4net/certs/.cert.pem -E 3 -V /usr/lib/ssl/certs
4     0  1365  1356  20   0  14460  5300 -      S    ?          0:38 /sbin/sslproxy -T 10 -P 443 -r 127.0.0.1:8080 -F 
IPADDR_0 -F ADDITIONAL_0 -c /one4n
et/certs/.cert.pem -E 3 -V /usr/lib/ssl/certs
1     0  4024   860  20   0   6740   116 -      S    ?          0:00 /sbin/httpd -port 8080 -address 127.0.0.1
4     3  4025  4024  20   0   7828   948 -      S    ?          0:00 /bin/access -C 0 -F 0 -H 3
0     3  4034  4025  20   0  11088  4152 -      S    ?          0:00 /bin/sh /etc/rc.d/config ps
0     3  4038  4034  20   0   7140   792 -      R    ?          0:00 /bin/ps alxwww
1     0 14514     2  20   0      0     0 -      S    ?          0:00 [kworker/u4:0]
1     0 27228     2  10 -10      0     0 -      S<   ?          0:11 [l7s 1]
1     0 27229     2  20   0      0     0 -      S    ?          0:10 [l7flow 1]
1     0 27230     2  20   0      0     0 -      S    ?          0:11 [l7flow 1]
1     0 27231     2  20   0      0     0 -      S    ?          0:12 [l7flow 1]
1     0 27232     2  20   0      0     0 -      S    ?          0:11 [l7flow 1]
1     0 27233     2  20   0      0     0 -      S    ?          0:11 [l7flow 1]
1     0 27235     2  20   0      0     0 -      S    ?          0:11 [l7flow 1]
1     0 27236     2  20   0      0     0 -      S    ?          0:10 [l7flow 1]
1     0 27238     2  20   0      0     0 -      S    ?          0:11 [l7flow 1]
0     0 29434     1  20   0   9540  2676 -      S    ?          0:00 /bin/bash /sbin/startDaemon /sbin/vsslproxy -C 0 -A -D 
/one4net/certs -V /usr/lib/s
sl/certs -T 10000 -i 660 -t 65536 -N 5 -E 2
4     0 29439 29434  20   0  16108  2856 -      S    ?          0:04 /sbin/vsslproxy -C 0 -A -D /one4net/certs -V 
/usr/lib/ssl/certs -T 10000 -i 660 -t 
65536 -N 5 -E 2
5     0 29479 29439  10 -10 282536  4564 -      S<l  ?          0:00 /sbin/vsslproxy -C 0 -A -D /one4net/certs -V 
/usr/lib/ssl/certs -T 10000 -i 660 -t 
65536 -N 5 -E 2

                            

						

                        
Top of page
				

				

					

						
 Get-LmExtendedLogFile 

						
List the existing extended log files.

						
Run this command to list the existing extended log files.

					

                        

                        
 Syntax 

                        

						

                            


Get-LmExtendedLogFile [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Get-LmExtendedLogFile [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN <String>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\&lt;CurrentUser&gt;\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Get-LmExtendedLogFile

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed; Data=@{EspLogFiles=}}
Return Code..: 200
Response.....: Command successfully executed

File1 : connection
File2 : connection-20181206.gz
File3 : security
File4 : security-20180918.gz
File5 : security-20180928.gz
File6 : security-20181003.gz
File7 : security-20181004.gz
File8 : security-20181010.gz
File9 : user

                            

						

                        
Top of page
				

				

					

						
 Get-LmHAConfiguration 

						
Allows you to view the values of High Availability (HA) options.

						
Retrieve the HA settings.

					

                        

                        
 Syntax 

                        

						

                            


Get-LmHAConfiguration [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Get-LmHAConfiguration [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN <String>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
						

                            

                                
 Note 

                            

							
To get the HA status, run the following command: Get-LmParameter -Param HAStatus
    To retrieve the HACheck parameter, run the following command: Get-NetworkInterface

						

                        

                            
 Examples 

                        

						

                            

							    Example

Get-LmHAConfiguration

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed; Data=}
Return Code..: 200
Response.....: Command successfully executed


hamode     : HA Second
hatimeout  : 3
hawait     : 0
havhid     : 0
haprefered : No Preferred Host
haif       : 0
hal4update : no
hal7update : no

                            

						

                        
Top of page
				

				

					

						
 Get-LmHAMode 

						
Retrieve the High Availability (HA) mode.

						
The HA mode is one of the following options:
0 – HA mode disabled
1 – HA 1 mode
2 – HA 2 mode
3 – System is using cloud HA
4 – System is in a cluster

					

                        

                        
 Syntax 

                        

						

                            


Get-LmHAMode [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction <ActionPreference>] 
[-InformationVariable <String>] [<CommonParameters>]

Get-LmHAMode [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN <String>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Get-LmHAMode

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed; Data=}
Return Code..: 200
Response.....: Command successfully executed
HaMode        : 2
HaDescription : HA Second

                            

						

                        
Top of page
				

				

					

						
 Get-LmIPConnectionLimit 

						
Displays a list of client IP address limiters.

						
Displays a list of client IP address limiters.

					

                        

                        
 Syntax 

                        

						

                            


Get-LmIPConnectionLimit [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Get-LmIPConnectionLimit [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN 
<String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Get-LmIPConnectionLimit

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.

Address     Mask Limit
-------     ---- -----
10.64.55.22 32   155

                            

						

                        
Top of page
				

				

					

						
 Get-LmNetworkInterface 

						
Retrieves details for the LoadMaster network interface.

						
Returns details about the LoadMaster network interface, such as the speed, name and Id number.

					

                        

                        
 Syntax 

                        

						

                            


Get-LmNetworkInterface [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Get-LmNetworkInterface [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN 
<String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Get-LmNetworkInterface

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.
Data field...: @{Interface=}
Param........: @{Id=0; Name=eth0; speed=10000; inbytes=11187190; inerrs=0; indrops=0; outbytes=21653858; outerrs=0; 
outdrops=0; link=up; lastchange=1492
686160}


Id         : 0
Name       : eth0
speed      : 10000
inbytes    : 11187190
inerrs     : 0
indrops    : 0
outbytes   : 21653858
outerrs    : 0
outdrops   : 0
link       : up
lastchange : 1492686160

                            

						

                        
Top of page
				

				

					

						
 Get-LmParameter 

						
A large number of LoadMaster parameters can be retrieved using the Get-LmParameter command.

						
Below is a list of the parameters that can be retrieved using the Get-LmParameter command. The parameters are grouped and 
ordered by WUI section.


-----------------
WUI Section: Home
-----------------


version
Retrieves the LoadMaster firmware version.


serialnumber
The serial number of the LoadMaster.


boottime
The time at which the LoadMaster last booted.


activetime
When using non-HA mode, the activetime is the same as the boottime. When in HA mode, the active time is the time at which 
the LoadMaster last became the master unit. The active time will be zero if the LoadMaster is in slave mode.


---------------------------------------------------------------------
WUI Section: Virtual Services > View/Modify Services > SSL Properties
---------------------------------------------------------------------


securityheaderage
The maximum age for the security header. Valid values for this parameter range from 86400 (1 day) to 31536000 (1 year).


--------------------------------------------------------------------------
WUI Section: Virtual Services > View/Modify Services > Advanced Properties
--------------------------------------------------------------------------


addvia
Specifies which headers should be added to the HTTP stream. The parameter takes the following arguments:
   0 = Legacy Operation
   1 = X-Forwarded-For
   2 = None
   3 = X-Client-Side
   4 = X-Client-Side No Via
   5 = X-Forwarded-For No Via
   6 = Via Only


------------------------------------
WUI Section: Certificates & Security
------------------------------------


localcert
This parameter is only relevant when using HA.


-------------------------------------------------------
WUI Section: Certificates & Security > SSL Certificates
-------------------------------------------------------


admincert
The certificate used, if any, for the administrative interface.


----------------------------------------------------
WUI Section: Certificates & Security > Remote Access
----------------------------------------------------


admingw
When administering the LoadMaster from a non-default interface, this option allows the user to specify a different default 
gateway for administrative traffic only.


sshaccess
Specify over which addresses remote administrative SSH access to the LoadMaster is allowed.


sshport
Specify the port used to access the LoadMaster via the SSH protocol.


wuiaccess
Enables or disables access to the Web User Interface (WUI).


wuiiface
Specifies the interface for the WUI.


wuiport
Specifies the port to access the WUI.


sshiface
Specify the addresses over which remote administrative SSH access to the LoadMaster is allowed.


enableapi
Enables the programmable command API Interface.
Note: If this is disabled, the API will no longer be accessible.


adminclientaccess
Valid values for this parameter are:
0 – Password only access (default)
1 – Password or client certificate
2 – Client certificate required
3 – Client certificate required (verify via OCSP)
This parameter is only relevant if Session Management is enabled. For further information on Session Management and on the 
Admin Client Access option, refer to the User Management, Feature Description on the Kemp documentation page: 
www.kemptechnologies.com/documentation


tethering
Allow the LoadMaster to regularly check the Kemp website for new software versions.
0 - Disabled
1 - Enabled


geoclients
Set the addresses of the GEO LoadMasters which can retrieve service status information from the LoadMaster.


geopartners
Set the IP address of the GEO LoadMaster partner(s). These GEO LoadMasters will keep their DNS configurations in sync.
Note: Before partnering GEO LoadMasters, a backup should be taken of the relevant GEO LoadMaster which has the 
correct/preferred configuration. This backup should then be restored to the other LoadMasters


that will be partnered with the original LoadMaster.


multihomedwui
Allow WUI access from multiple interfaces. Apart from the main administrative interface, each interface can then be enabled 
to allow WUI access.


SSHPreAuth
Set the SSH pre-authentication banner, which is displayed before the login prompt when logging in via SSH. Space characters 
should be escaped by entering %20.
This field accepts up to 5,000 characters. Anything past the 5,000 character limit will not be displayed.


sessioncac
If this parameter is enabled, the LoadMaster will also check for a Common Access Card (CAC) certificate when a user is 
logging on to the WUI.
0 - Disabled
1 - Enabled


--------------------------------------------------------------------------------
WUI Section: Certificates & Security > Remote Access > WUI Authorization Options
--------------------------------------------------------------------------------


sessionauthmode
Specifies the authentication mode for the LoadMaster.
Refer to the following table for values:


|          RADIUS             |     LDAP      |        Local
Value    |    Authent.    Author.  |   Authent.   |  Authent.    Author.
7           |    No          No            |   No            |  No          No
263       |    Yes         No             |   No           |  Yes         Yes
775       |    Yes         Yes             |   No           |  Yes         Yes
23         |   No          No             |   Yes           |  Yes         Yes
22         |    No          No            |   Yes           |  No          Yes
788       |    Yes         Yes            |   Yes           |  No          No
790       |    Yes         Yes            |   Yes           |  No          Yes
791       |    Yes         Yes            |   Yes           |  Yes         Yes
789       |    Yes         Yes            |   Yes           |  Yes         No
773       |    Yes         Yes            |   No           |  Yes         No
262       |    Yes         No            |   No           |  No          Yes
774       |    Yes         Yes            |   No           |  No          Yes
772       |    Yes         Yes            |   No           |  No          No
278       |    Yes         No            |   Yes           |  No          No
279       |    Yes         No            |   Yes           |  Yes         Yes


sessionlocalauth
Enables or disables local authentication.


radiusbackupport
Specifies the TCP port for the backup RADIUS server.


radiusbackupsecret
Specifies the password (secret) to the backup RADIUS server.


radiusbackupserver
Specifies the backup RADIUS server to use for authentication.


radiusport
Specifies the TCP port for communication to the RADIUS server.


radiussecret
Specifies the password (secret) to the RADIUS server.


radiusserver
Specifies the RADIUS server to use for authentication.


radiusrevalidateinterval
Specifies when to revalidate the authentication to the RADIUS server.


radiussendnasid
If this parameter is disabled (default), a Network Access Server (NAS) identifier is not sent to the RADIUS server. If it 
is enabled, a NAS identifier string is sent to the RADIUS server. By default, this is the hostname. Alternatively, if you 
specify a value in the radiusnasid parameter, this value is used as the NAS identifier. If the NAS identifier cannot be 
added, the RADIUS access request is still processed.


radiusnasid
If the radiussendnasid parameter is enabled, the radiusnasid parameter is relevant. When specified, this value is used as 
the NASidentifier. Otherwise, the hostname is used as the NAS identifier. If the NAS identifier cannot be added, the RADIUS 
access request is still processed.


ldapserver
Specifies the LDAP server to use for authentication.


ldapbackupserver
Specifies the backup LDAP server for authentication.


ldapsecurity
Specifies the security mode for LDAP authentication.


ldaprevalidateinterval
Specifies how often to revalidate the authentication to the LDAP server.


wuidomain
Specify the domain to use if no domain is provided in the username when group WUI authentication is in use. It is always 
used as the domain for group search if the Windows logon is used in the format prefix\username.


-------------------------------------------------------
WUI Section: Certificates & Security > Admin WUI Access
-------------------------------------------------------


sessionidletime
Specifies the number of seconds that the WUI can be idle before logging the user out. This can be set from 60 to 86400 
seconds.


sessionmaxfailattempts
Number of failed attempts before locking the user account. This can be set from 1 to 999.


sessioncontrol
Enables or disables session control.


sessionbasicauth
If the SessionControl and SessionBasicAuth parameters are both enabled, there are two levels of authentication enforced in 
order to access the LoadMaster WUI. The initial level is Basic Authentication where


users log in using the bal or user logins, which are default usernames defined by the system.


sessionconcurrent
Limit the maximum number of concurrent connections a single user can have. 
Range: 0 to 9. A value of 0, means logins are unlimited.


geosshport
The port over which GEO LoadMasters will communicate with on another.


WUIPreAuth
Set the pre-authentication click through banner which will be displayed before the LoadMaster login page. This parameter 
can contain plain text or HTML code. The field cannot contain JavaScript. This field


accepts up to 5,000 characters. Anything past the 5,000 character limit will not be displayed.


WUITLSProtocols
Specify whether or not it is possible to connect to the LoadMaster WUI using the following protocols; SSLv3, TLS1.0, TLS1.1 
or TLS1.2. The protocols can be enabled and disabled using a bitmask value in the range 0 to 14. Refer to the table below 
to find out what number corresponds to which settings.


Number |   SSLv3     | TLS1.0   | TLS1.1    | TLS1.2
0      |   Enabled   | Enabled  | Enabled   | Enabled
1      |   Disabled  | Enabled  | Enabled   | Enabled
2      |   Enabled   | Disabled | Enabled   | Enabled
3      |   Disabled  | Disabled | Enabled   | Enabled
4      |   Enabled   | Enabled  | Disabled  | Enabled
5      |   Disabled  | Enabled  | Disabled  | Enabled
6      |   Enabled   | Disabled | Disabled  | Enabled
7      |   Disabled  | Disabled | Disabled  | Enabled
8      |   Enabled   | Enabled  | Enabled   | Disabled
9      |   Disabled  | Enabled  | Enabled   | Disabled
10     |   Enabled   | Disabled | Enabled   | Disabled
11     |   Disabled  | Disabled | Enabled   | Disabled
12     |   Enabled   | Enabled  | Disabled  | Disabled
13     |   Disabled  | Enabled  | Disabled  | Disabled
14     |   Enabled   | Disabled | Disabled  | Disabled


WUICipherset
Specify the cipher set to use for the LoadMaster WUI. System-defined cipher sets and custom cipher sets can be assigned 
using this parameter. The valid values are below:
 - Default
 - Default_NoRc4
 - BestPractices
 - Intermediate_compatibility
 - Backward_compatibility
 - WUI
 - FIPS
 - Legacy
 - Null_Ciphers
 - <NameOfCustomCipherSet>
The Null_Ciphers set is only for Direct Access and IP-HTTPS VIPs for Windows 8/10 clients.
The Null_Ciphers set does not work on Cavium3 machines.


---------------------------------------------------------
WUI Section: Certificates & Security > OCSP Configuration
---------------------------------------------------------


OCSPPort
The port of the OCSP server.


OCSPUseSSL
Specify whether or not to use SSL to connect to the OCSP server.


OCSPOnServerFail
Treat an OCSP server connection failure of timeout as if the OCSP server had returned a valid response, i.e. treat the 
client certificate as valid.


OCSPServer
The address of the OCSP server.


OCSPUrl
The URL to access on the OCSP server.


SSLStapling
Enable this parameter to enable the LoadMaster to respond to OCSP stapling requests. If a client connects using SSL and 
asks for an OCSP response, this is returned. Only Virtual Service certificates are validated. The system holds a cache of 
OCSP responses that are sent back to the client. This cache is maintained by the OCSP daemon. When the OCSP daemon sends a 
request to the server, it uses the name specified in the certificate (in the Authority Information Access field). If it 
cannot resolve this name, then it uses the default OCSP server specified in the OCSPServer parameter.


SSHRefreshInterval
Specify how often the LoadMaster should refresh the OCSP stapling information. The OCSP daemon caches the entry for up to 
the amount of time specified here, after which it is refreshed.
Valid values range from 3600 (1 hour (default)) to 86400 seconds (24 hours).


--------------------------------------------------------------
WUI Section: System Configuration > Network Setup > Interfaces
--------------------------------------------------------------


mcast
The network interface used for multicast traffic which is used to synchronize Layer 4 and Layer 7 traffic when Inter HA 
Updates are enabled.


----------------------------------------------------------------------------
WUI Section: System Configuration > Network Setup > Host & DNS Configuration
----------------------------------------------------------------------------


dnssecclient
Enable or disable DNSSEC client capabilities on the LoadMaster. At least one name server must be configured before DNSSEC 
can be enabled. After changing this setting, the LoadMaster must be rebooted for the change to be applied. Once the setting 
is changed, it cannot be changed again until the LoadMaster has been rebooted. If using HA, please set the parameter on 
both devices separately.
   0 = Disabled
   1 = Enabled


DNSNamesEnable
When this option is enabled, the LoadMaster automatically attempts to update any changed DNS names (based on the update 
interval):
- If the address is not found, or if it is the same as before – nothing is done (except a log entry is generated).
- If the address is different, the Real Server entry is updated with the new address, if possible.
- If the new address is invalid for some reason, for example if it is a non-local address and the nonlocalrs option is 
disabled, no changes are made and a log is generated.


dnsupdateinterval
Set the update interval for DNS entries. Valid values range from 1-60 (minutes). The default value is 60.


dnsreloadonerror
If this parameter is enabled, DNS entries are reloaded when health checks have errors and an FQDN is associated with the 
Real Server IPaddress.


namserver
The DNS server the LoadMaster will use for name resolution. Setting this parameter to an empty string will delete the name 
servers. The last remaining name server cannot be deleted if the dnssecclient parameter is enabled. This parameter has been 
deprecated and replaced with the nameserver parameter.


nameserver
The DNS server the LoadMaster will use for name resolution. Setting this parameter to an empty string will delete the name 
servers. The last remaining name server cannot be deleted if the dnssecclient parameter is enabled.


ha1hostname
When using the LoadMaster in HA mode, this is the host name of the first node. If the LoadMaster is not in HA mode, then 
this will return an error.


ha2hostname
When using the LoadMaster in HA mode, this is the host name of the second node. If the LoadMaster is not in HA mode, then 
this will return an error.


hostname
The hostname assigned to the LoadMaster.


searchlist
The domain suffix search list when performing DNS resolution.


-------------------------------------------------------------------
WUI Section: System Configuration > Network Setup > Default Gateway
-------------------------------------------------------------------


Before setting the default gateway, the network interface addresses must be configured, for example:
Set-NetworkInterface -GWIface 1


Dfltgw
Specify the IPv4 default gateway that is to be used for communicating with the internet.


dfltgwv6
Specify the IPv6 default gateway that is to be used for communicating with the internet.


---------------------------------------------------------------------------
WUI Section: System Configuration > System Administration > User Management
---------------------------------------------------------------------------


extendedperms
The Virtual Service operations permitted vary depending on whether or not the extendedperms parameter is enabled. For 
further information, refer to the UserManagement Feature Description on the Kemp Documentation Page: 
https://kemptechnologies.com/loadmaster-documentation/.


--------------------------------------------------------------------------
WUI Section: System Configuration > System Administration > Update License
--------------------------------------------------------------------------


hideaslloginmsg
If this parameter is enabled, the activation licensing text for Kemp 360 Central is shown on the LoadMaster login screen.
0 - Disabled
1 - Enabled


--------------------------------------------------------------------------
WUI Section: System Configuration > System Administration > Backup/Restore
--------------------------------------------------------------------------


backupday
For scheduled backups, this parameter specifies the "day" number (0-7).


backupenable
Specifies if scheduled backups are enabled.


backuphost
Specifies the host to save the backup file to.


backuphour
For scheduled backups, this parameter specifies the "hour" number (0-23).


backupminute
For scheduled backups, this parameter specifies the "minute" number (0-59).


backupmethod
Specify the file transfer method for automated backups. Valid values are:
Ftp
SCP
sftp


backuppassword
Specifies the password for the user account that has access to save the backup file.


backuppath
Specifies the path on the remote host for saving the backup file.


backupuser
Specifies the user account that has access to save the backup file.


---------------------------------------------------------------------
WUI Section: System Configuration > System Administration > Date/Time
---------------------------------------------------------------------


ntphost
Specifies the time synchronization server. Multiple hosts can be specified using a space-separated list.


ntpkeytype
Specify the NTP Key Type. The valid values are SHA-1 (SHA) and MD5 (M). The values must be specified in uppercase.


ntpkeysecret
The NTP shared secret string. The NTP secret can be a maximum of 40 characters long. If the secret is more than 20 
characters long, it is treated as a hex string. Setting this value to an empty string will disable the NTPv4 feature.


ntpkeyid
The NTP key ID. Valid values range from 1 to 99.


timezone
Specifies the time zone of the LoadMaster.


time
Sets the time of the LoadMaster.


-------------------------------------------------------------------
WUI Section: System Configuration > Logging Options > Debug Options
-------------------------------------------------------------------


irqbalance
The purpose of IRQBalance is distribute hardware interrupts across processors on a multiprocessor system. This should only 
be enabled after consultation with Kemp Technical Support.


backuptop
By default, the LoadMaster does not include top command output in a backup. To include it, enable the backuptop parameter. 
When included in backups, top is run using the default parameters (regardless of what is configured in the WUI) and is 
sorted by memory usage.


backupnetstat
By default, the LoadMaster includes a Netstat output in backups taken. When this is included, backups take longer to 
complete. You can stop the Netstat output from being included by disabling this parameter.


linearesplogs
By default, the LoadMaster deletes older log files. If this parameter is enabled, older log files will no longer be 
deleted. If the filesystem fills up, further access via the LoadMaster is blocked.


netconsole
Netconsole is a kernel module which logs kernel printk messages over UDP allowing debugging of problems where disk logging 
fails. If directed by a Kemp support engineer, the syslog daemon on a specific host


will receive all critical kernel messages. This can help in understanding why a LoadMaster is rebooting.


netconsoleinterface
The interface which hosts the Netconsole.


--------------------------------------------------------------------
WUI Section: System Configuration > Logging Options > Syslog Options
--------------------------------------------------------------------


syslogemergency
Use this option to set the host(s) which will receive Emergency events only. Entries must be comma-separated. Up to 10 
entries are supported in total for all levels.


syslogcritical
Use this option to set the host(s) which will receive Emergency and Critical events. Entries must be comma-separated. Up to 
10 entries are supported in total for all levels.


syslogerror
Use this option to set the host(s) which will receive Emergency, Critical and Error events. Entries must be 
comma-separated. Up to 10 entries are supported in total for all levels.


sysloginfo
Use this option to set the host(s) which will receive Emergency, Critical, Error and Warning events. Entries must be 
comma-separated. Up to 10 entries are supported in total for all levels.


syslognotice
Use this option to set the host(s) which will receive Emergency, Critical, Error, Warning and Notice events. Entries must 
be comma-separated. Up to 10 entries are supported in total for all levels.


syslogwarn
Use this option to set the host(s) which will receive All events. Entries must be comma-separated. Up to 10 entries are 
supported in total for all levels.


syslognone
Use the Set-LmParameter command with this option to delete a host, or hosts, from any syslog level. Because you can only 
assign a specific host to one level, you do not need to specify the syslog level to remove the host from. Entries must be 
comma-separated. Up to 10 entries can be deleted at once.
The Get-LmParameter command does not retrieve anything for this parameter.


syslogport
Specify the port that syslog messages are sent to on the receiving hosts.


------------------------------------------------------------------
WUI Section: System Configuration > Logging Options > SNMP Options
------------------------------------------------------------------


snmpenable
Enable or disable SNMP.


snmpV3enable
Enable SNMP V3.
   0 = Disabled
   1 = Enabled


snmpv3user
Specify the username.


snmpv3userpasswd
Specify the user password.


snmpAuthProt
Specify the relevant authentication protocol:
   - MD5
   - SHA
SHA is a more secure protocol.


snmpPrivProt
Specify the relevant privacy protocol:
   - DES
   - AES
AES is a more secure protocol.


snmpcontact
Specify the contact address that is sent in SNMP responses.


snmpcommunity
Specify the SNMP community string.


snmplocation
Specify the location that is sent in SNMP responses.


snmpHaTrap
Send SNMP traps from the shared IP address. This option is only available when the LoadMaster is in HA mode.


snmpv1sink
Specify the sink address for SNMP type 1 traps.


snmpv2sink
Specify the sink address for SNMP type 2 traps.


snmpclient
Specify the list of machines that can access the SNMP subsystem. If no clients are specified, then anyone can access SNMP.


snmptrapenable
Enable the generation of SNMP events whenever a significant event occurs.


-------------------------------------------------------------------
WUI Section: System Configuration > Logging Options > Email Options
-------------------------------------------------------------------


emailuser
The user account with access to send mail messages.


emaildomain
The domain, if required, for the user account authentication.


emailpassword
The email user's password.


emailserver
The host name or address of the SMTP server to send mail messages through.


emailsslmode
Specify the type of security protocol that should be used on the connection:
   0 = None
   1 = STARTTLS, if available
   2 = STARTTLS
   3 = SSL/TLS


emailport
The TCP port on which your mail server accepts connections (usually 25).


emailcritical
The email address to receive critical messages.


emailemergency
The email address to receive emergency messages.


emailerror
The email address to receive error messages.


emailinfo
The email address to receive informational messages.


emailnotice
The email address to receive notices.


emailwarn
The email address to receive warnings.


emailenable
Enables or disables the email logging options.


-------------------------------------------------------------------
WUI Section: System Configuration > Logging Options > SDN Log Files
-------------------------------------------------------------------


sdnstatsmode
There are two modes that can be used to gather the SDN statistics.
The modes are described below:
• Mode 1: When set to mode 1, the statistics are taken from the switch port that is connected to the server and the 
statistics are relayed back to the LoadMaster.
• Mode 2: When set to mode 2, the information is taken from all of the switch ports along the path.


------------------------------------------------------------------------
WUI Section: System Configuration > Miscellaneous Options > WUI Settings
------------------------------------------------------------------------


hoverhelp
Enables or disables hover help in the WUI.


motd
Sets the Message Of The Day (MOTD) for the web user interface. Either plain text or a text file can be used.
The maximum number of characters is 5,000.
An error will be displayed if the MOTD is greater than 5,000 characters.


wuidisplaylines
Specifies the number of display lines in the WUI. This can be set from 10 to 100.


----------------------------------------------------------------------------
WUI Section: System Configuration > Miscellaneous Options > L7 Configuration
----------------------------------------------------------------------------


transparent
When using Layer 7, when this is enabled the connection arriving at the Real Server appears to come directly from the 
client. Alternatively, the connection can be non-transparent which means that the


connections at the Real Server appear to come from the LoadMaster.


alwayspersist
This parameter also accepts no and yes as valid values. No and Yes correspond to 0 and 1 respectively.


expect100
By default, the L7 module only waits for 100-Continue replies if it sees an Expect-100 header, use RFC-2616 Compliant. If 
the system will always wait for 100 Continue messages, use Require 100-Continue. If


the client will always send the POST data even if a 100 Continue message is not sent, use RFC-7231 Compliant instead.


localbind
In very high load situations, local port exhaustion can occur. Enabling this option allows the setting of alternate source 
addresses. This can be used to expand the number of available local ports.


addcookieport
When using the LoadMaster behind a NATing gateway, all client addresses are the same. To create individual cookies the 
remote port can also be added to the cookie. Enabling this option when not needed wastes


resources.


addforwardheader
This option, only available when L7 Transparency is disabled, allows the addition of either X-ClientSide or X-Forwarded For 
to the HTTP header.


authtimeout
The duration (in seconds) that a connection remains open for while authentication is ongoing. This value can be between 30 
and 300.


clienttokentimeout
The duration (in seconds) to wait for the client token while the process of authentication is ongoing (used for RSA SecurID 
and RADIUS authentication). The default value for this parameter is 120.


finalpersist
When a Real Server is disabled, the sessions persisting on that Real Server continue to be served until the Drain Time has 
expired or until no more sessions are being handled by the Real Server. No new sessions will be handled by the Real Server. 
Valid values include 0, and 60 to 86400.


rfcconform
By default, the LoadMaster conforms to the RFC when parsing HTTP headers. Disabling this will allow interworking with some 
broken browsers.


dropatdrainend
If enabled, all open connections to disabled Real Servers will be dropped at the end of the Real Servers Drain Stop Time or 
immediately if there are no Persist entries associated with the Real Server.


droponfail
By default, existing connections are not closed if a Real Server fails. Enabling this feature causes all connections to be 
immediately dropped on Real Server failure.


closeonerror
When enabled, the LoadMaster will always close the client connection when it sends back an error response. For Example, 
this changes the behaviour of the LoadMaster when sending back a 304 File not changed


message after receiving an If-Modified-Since HTTP header.


rsarelocal
When checking to see if a client is on the local subnet, also check to see if the client is actually a Real Server.


slowstart
When using the Least Connection (or Weighted Least Connection) scheduling method, specify the time (in seconds) over which 
the load to a Real Server which has just come online will be throttled.


ShareSubVSPersist
By default, each SubVS has an independent persistence table. Enabling this parameter will allow the SubVS to share this 
information.


logsplitinterval
When using Log Insight Scheduling this is the number of messages which are received on a connection before the stream is 
rescheduled. The default value is 10.


allowemptyposts
By default the LoadMaster blocks POSTs that do not contain a Content-Length or Transfer-Encoding header to indicate the 
length of the requests payload. When this parameter is set to true, such requests are assumed to have no payload data and 
are therefore not rejected.


forcefullrsmatch
By default, when the LoadMaster is trying to locate a Real Server for use with content switching, it tries to use the same 
Real Server as currently selected, even if the port is not the same. If this parameter is enabled - the port is also 
compared.


AllowEmptyHttpHeaders
By default, if the LoadMaster is processing HTTP headers, it will ignore HTTP headers that have empty content. This can 
break some SOAP Services even though it is against the HTTP RFCs. Enabling this option will allow these empty headers 
through.


loguseragent
When enabled, the User Agent header field is added to the User Logs.
0 - Disabled
1 - Enabled


---------------------------------------------------------------------------
WUI Section: System Configuration > Miscellaneous Options > Network Options
---------------------------------------------------------------------------


snat
Enabling this options allows the LoadMaster to NAT connections from the Real Servers to the internet.


routefilter
When enabled, this option only accepts IP frames from a host over the interface where the routing algorithm would route 
frames to the host. This is known as strict source route validation.


subnetoriginating
When transparency is disabled for a Virtual Service, the source IP address of connections to Real Servers is the Virtual 
Service. When enabled, the source IP address is the local address of the LoadMaster.


If the Real Server is on a subnet, the subnet address of the LoadMaster will be used.


nonlocalrs
Enable this option to allow assigning non-local Real Servers to Virtual Services.


multigw
Use this option to enable the ability to move the default gateway to a different interface.
Note: Alternate default gateway support is not permitted in a cloud environment.


conntimeout
Specify the timeout value for the check request.
Range: 4-60


tcptimestamp
The LoadMaster can include a timestamp in the SYN when connecting to Real Servers. Only enable this option when requested 
to from Kemp Support.


resetclose
When enabled, the LoadMaster will close its connection to the Real Servers by using TCP RESET instead of the normal close 
handshake.


keepalive
By default, the system uses TCP keepalives to check for failed clients. Enabling this option improves the reliability of 
older TCP connections (SSH sessions). Not normally required for normal HTTP/HTTPS


services.


allowupload
The LoadMaster has been optimized with HTTP workloads in mind. Enabling this option allows non HTTP uploads to work 
correctly.


subnetorigin
When transparency is disabled for a Virtual Service, the source IP address of connections to Real Servers is the Virtual 
Service. When enabled, the source IP address is the local address of the LoadMaster.


If the Real Server is on a subnet, the subnet address of the LoadMaster will be used.


onlydefaultroutes
Enable this option to force traffic from Virtual Services, which have default route entries set, to be routed to the 
interface where the Virtual Service’s default route is located.


http_proxy
This option allows clients to specify the HTTP(S) proxy server and port the LoadMaster will use to access the internet.


dhkeysize
Select the strength of the key used in the Diffe-Hellman key exchanges. If this value is changed, a reboot is required in 
order to use the new value. The default value is 2048 Bits.


sslrenegotiate
By default, the LoadMaster allows a client to automatically renegotiate during an SSL transaction. Disabling this parameter 
causes SSL connections to terminate if a renegotiation is requested by the client.


sslforceserververify
By default, when re-encrypting traffic the LoadMaster does not check the certificate provided by the Real Server. Enabling 
this option forces the LoadMaster to verify that the certificate on the Real Server is valid, that is, the certificate 
authority and expiration are OK. This includes all intermediate certificates.


tcpnorecycle
Enable this option to revert to the legacy mode of reusing TCP timewait connections.
Note: Only enable this after consulting with Kemp Support.


-----------------------------------------------------------------------------
WUI Section: System Configuration > Miscellaneous Options > AFE Configuration
-----------------------------------------------------------------------------


paranoia
Sets the sensitivity of IDS detection.


cachesize
Specifies the cache size.


hostcache
Enable or disable using the host cache.


limitinput
Limit the number of connections.


L7LimitInput
This setting limits the default maximum number of connection attempts (per second) from a specific host.


-------------------------------------------------------------------------
WUI Section: System Configuration > Miscellaneous Options > HA Parameters
-------------------------------------------------------------------------


hastatus
The status of a HA or cluster unit. This is a read only parameter and cannot be set. Possible values are:
Normal HA:
Active, Standby, Passive (all as expected).
Cloud HA:
Active, Standby, Passive (if status not yet set).
Cluster: 
Active (if master), Standby (if slave), Passive (if disabled).


hatimeout
The time the master must be unavailable before a switchover occurs. Allowed Values: 1-5, each option being a predetermined 
time interval:
    1 = 3 seconds
    2 = 6 seconds
    3 = 9 seconds
    4 = 12 seconds
    5 = 15 seconds


hawait
This is how long (in seconds) after the initial boot, before the LoadMaster becomes active. If the partner machine is 
running this value is ignored. This value can be changed to mitigate the time taken for  some intelligent switches to 
detect that the LoadMaster has started and to bring up the link.


haprefered
By default, neither partner in a HA cluster has priority. When a machine restarts after a switchover that machine becomes a 
slave. Specifying a preferred host means that when this machine restarts it will always become the master and the partner 
will revert to slave mode.


hamode
Specify the HA mode. If only using a single LoadMaster, use Non-HA Mode. In HA mode, one LoadMaster must be specified as 
the first and another as second. HA will not work if both LoadMasters are specified


the same.
   0 = Turn off HA mode
   1 = HA 1 mode
   2 = HA 2 mode


haif
The network interface used when synchronising the configuration between the members of the HA cluster.


havhid
When using multiple HA LoadMasters on the same network, this value identifies each cluster so that there are no potential 
unwanted interactions.


hastyle
By default, the system uses a version of VRRP (carp) to check the status of the partner. The system can also support the 
legacy Heartbeat program. This option only takes effect when both machines are rebooted.
0 - legacy heartbeat
1 - carp


hainitial
Perform extra network checks at boot time. This may cause instability and should not be used.


tcpfailover
When using L4 services, enabling updates allows L4 connection maintenance across a HA switchover. This option is ignored 
for L7 services.
This parameter is now deprecated and has been replaced with the HAL4update parameter.


cookieupdate
When using L7 services, enabling this option allows sharing of persistency information between HA partners. If a HA 
switchover occurs, the persistency information will then not be lost. Enabling this option


can have a significant performance impact.
This parameter is now deprecated and has been replaced with the HAL7Update parameter.


hal4update
When using L4 services, enabling updates allows L4 connection maintenance across a HA switchover. This option is ignored 
for L7 services.


hal7update
When using L7 services, enabling this option allows sharing of persistency information between HA partners. If a HA 
switchover occurs, the persistency information will then not be lost. Enabling this option  can have a significant 
performance impact.


vmac
This option creates a shared MAC address for both units. When failover occurs, the LoadMaster handles the MAC address 
handover too. This allows the switches to keep the MAC address and not worry about ARP caches or stale records.

					

                        

                        
 Syntax 

                        

						

                            


Get-LmParameter -Param <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Get-LmParameter -Param <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN 
<String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-Param
                                        
										The parameter to retrieve.
										true
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Get-LmParameter -Param SSLRefreshInterval

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.
Data field...: @{SSLRefreshInterval=3700}

                            

						

                        
Top of page
				

				

					

						
 Get-LmPreviousFirmwareVersion 

						
Retrieve the firmware version that was previously installed on the LoadMaster.

						
This command returns the firmware version number for the last installed firmware version before the current one.

					

                        

                        
 Syntax 

                        

						

                            


Get-LmPreviousFirmwareVersion [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Get-LmPreviousFirmwareVersion [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN 
<String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Get-LmPreviousFirmwareVersion

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.
Data field...: @{PreviousVersion=7.2.39.0.14938.DEV.20170411-1306
}

                            

						

                        
Top of page
				

				

					

						
 Get-LmProcessesInfo 

						
Performing a top displays memory, CPU, and I/O usage for the LoadMaster.

						
You can specify the number of samples and an interval between them (the default is 10 samples and a 1 second interval). You 
can also show threads and/or sort by memory usage by selecting the appropriate check boxes.

					

                        

                        
 Syntax 

                        

						

                            


Get-LmProcessesInfo [-iterations <Int32>] [-interval <Int32>] [-mem <SwitchParameter>] [-threads <SwitchParameter>] 
[-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction <ActionPreference>] 
[-InformationVariable <String>] [<CommonParameters>]

Get-LmProcessesInfo [-iterations <Int32>] [-interval <Int32>] [-mem <SwitchParameter>] [-threads <SwitchParameter>] 
[-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN <String>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-iterations
                                        
										Specify the number of samples (the default is 10 samples).
Range: 1-30		
										false
										false
										
									

									

										-interval
                                        
										Specify the interval between them (the default is a 1 second interval).
Range: 1-30		
										false
										false
										
									

									

										-mem
                                        
										By default the results are sorted by CPU usage. Use this switch parameter to sort by memory usage.
										false
										false
										
									

									

										-threads
                                        
										Use this switch parameter to show process threads.
										false
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Get-LmProcessesInfo

							    
Example Output:
Return Code..: 200
Response.....: Command successfully executed.
Data field...: @{top=}
Param........: 

top - 14:03:27 up  2:11,  0 users,  load average: 0.00, 0.00, 0.00
Tasks: 116 total,   1 running, 114 sleeping,   0 stopped,   1 zombie
%Cpu(s):  0.9 us,  1.1 sy,  0.0 ni, 97.8 id,  0.2 wa,  0.0 hi,  0.0 si,  0.0 st
KiB Mem:   2056628 total,   322852 used,  1733776 free,     1184 buffers
KiB Swap:        0 total,        0 used,        0 free.    43228 cached Mem

  PID USER      PR  NI    VIRT    RES    SHR S  %CPU %MEM     TIME+ COMMAND
    1 root      20   0    4352   1468   1360 S   0.0  0.1   1:23.21 init
    2 root      20   0       0      0      0 S   0.0  0.0   0:00.17 kthreadd
    3 root      20   0       0      0      0 S   0.0  0.0   0:00.07 ksoftirqd/0
    4 root      20   0       0      0      0 S   0.0  0.0   0:00.00 kworker/0:0
    5 root       0 -20       0      0      0 S   0.0  0.0   0:00.00 kworker/0:+
    7 root      20   0       0      0      0 S   0.0  0.0   0:02.51 rcu_sched
    8 root      20   0       0      0      0 S   0.0  0.0   0:00.00 rcu_bh
    9 root      rt   0       0      0      0 S   0.0  0.0   0:00.31 migration/0
   10 root       0 -20       0      0      0 S   0.0  0.0   0:00.00 lru-add-dr+
   11 root      rt   0       0      0      0 S   0.0  0.0   0:00.03 watchdog/0
   12 root      20   0       0      0      0 S   0.0  0.0   0:00.00 cpuhp/0
   13 root      20   0       0      0      0 S   0.0  0.0   0:00.00 cpuhp/1
   14 root      rt   0       0      0      0 S   0.0  0.0   0:00.02 watchdog/1
   15 root      rt   0       0      0      0 S   0.0  0.0   0:00.31 migration/1
   16 root      20   0       0      0      0 S   0.0  0.0   0:00.08 ksoftirqd/1
   17 root      20   0       0      0      0 S   0.0  0.0   0:00.00 kworker/1:0
   18 root       0 -20       0      0      0 S   0.0  0.0   0:00.00 kworker/1:+
   19 root       0 -20       0      0      0 S   0.0  0.0   0:00.00 netns
   20 root      20   0       0      0      0 S   0.0  0.0   0:00.00 khungtaskd
   21 root      20   0       0      0      0 S   0.0  0.0   0:00.00 oom_reaper
   22 root       0 -20       0      0      0 S   0.0  0.0   0:00.00 writeback
   23 root      20   0       0      0      0 S   0.0  0.0   0:00.00 kcompactd0
   24 root       0 -20       0      0      0 S   0.0  0.0   0:00.00 crypto
   25 root      20   0       0      0      0 S   0.0  0.0   0:02.81 kworker/1:1
   26 root       0 -20       0      0      0 S   0.0  0.0   0:00.00 bioset
   27 root       0 -20       0      0      0 S   0.0  0.0   0:00.00 kblockd
   28 root      20   0       0      0      0 S   0.0  0.0   0:00.63 kworker/0:1
   29 root       0 -20       0      0      0 S   0.0  0.0   0:00.00 ata_sff
   30 root       0 -20       0      0      0 S   0.0  0.0   0:00.00 watchdogd
   32 root      20   0       0      0      0 S   0.0  0.0   0:00.00 kswapd0
   33 root       0 -20       0      0      0 S   0.0  0.0   0:00.00 vmstat
   57 root       0 -20       0      0      0 S   0.0  0.0   0:00.00 acpi_therm+
   59 root       0 -20       0      0      0 S   0.0  0.0   0:00.00 bioset
   60 root       0 -20       0      0      0 S   0.0  0.0   0:00.00 bioset
   61 root       0 -20       0      0      0 S   0.0  0.0   0:00.00 bioset
   62 root       0 -20       0      0      0 S   0.0  0.0   0:00.00 bioset
   63 root       0 -20       0      0      0 S   0.0  0.0   0:00.00 bioset
   64 root       0 -20       0      0      0 S   0.0  0.0   0:00.00 bioset
   65 root       0 -20       0      0      0 S   0.0  0.0   0:00.00 bioset
   66 root       0 -20       0      0      0 S   0.0  0.0   0:00.00 bioset
   67 root       0 -20       0      0      0 S   0.0  0.0   0:00.00 bioset
   68 root       0 -20       0      0      0 S   0.0  0.0   0:00.00 bioset
   69 root       0 -20       0      0      0 S   0.0  0.0   0:00.00 bioset
   70 root       0 -20       0      0      0 S   0.0  0.0   0:00.00 bioset
   71 root       0 -20       0      0      0 S   0.0  0.0   0:00.00 bioset
   72 root       0 -20       0      0      0 S   0.0  0.0   0:00.00 bioset
   73 root       0 -20       0      0      0 S   0.0  0.0   0:00.00 bioset
   74 root       0 -20       0      0      0 S   0.0  0.0   0:00.00 bioset
   75 root       0 -20       0      0      0 S   0.0  0.0   0:00.00 bioset
   76 root       0 -20       0      0      0 S   0.0  0.0   0:00.00 bioset
   77 root       0 -20       0      0      0 S   0.0  0.0   0:00.00 bioset
   78 root       0 -20       0      0      0 S   0.0  0.0   0:00.00 bioset
   79 root       0 -20       0      0      0 S   0.0  0.0   0:00.00 bioset
   80 root       0 -20       0      0      0 S   0.0  0.0   0:00.00 bioset
   81 root       0 -20       0      0      0 S   0.0  0.0   0:00.00 bioset
   82 root       0 -20       0      0      0 S   0.0  0.0   0:00.00 bioset
   83 root       0 -20       0      0      0 S   0.0  0.0   0:00.00 fc_exch_wo+
   84 root       0 -20       0      0      0 S   0.0  0.0   0:00.00 fc_rport_eq
   85 root       0 -20       0      0      0 S   0.0  0.0   0:00.00 fnic_event+
   86 root       0 -20       0      0      0 S   0.0  0.0   0:00.00 fnic_fip_q
   87 root      20   0       0      0      0 S   0.0  0.0   0:00.00 scsi_eh_0
   88 root       0 -20       0      0      0 S   0.0  0.0   0:00.00 scsi_tmf_0
   89 root       0 -20       0      0      0 S   0.0  0.0   0:00.00 vmw_pvscsi+
   90 root       0 -20       0      0      0 S   0.0  0.0   0:00.00 bioset
  106 root       0 -20       0      0      0 S   0.0  0.0   0:00.00 ixgbevf
  107 root       0 -20       0      0      0 S   0.0  0.0   0:00.00 ipv6_addrc+
  108 root       0 -20       0      0      0 S   0.0  0.0   0:00.00 kworker/0:+
  109 root       0 -20       0      0      0 S   0.0  0.0   0:00.00 ext4-rsv-c+
  289 bal       20   0   26820   1404    988 S   0.0  0.1   0:00.42 nscd
  296 root       0 -20       0      0      0 S   0.0  0.0   0:00.00 kworker/1:+
  307 root       0 -20       0      0      0 S   0.0  0.0   0:00.01 loop0
 1492 root      20   0       0      0      0 S   0.0  0.0   0:00.00 kworker/u4+
 1774 root       0 -20       0      0      0 S   0.0  0.0   0:00.03 loop1
 2150 root      20   0    4388   1732   1596 S   0.0  0.1   0:00.07 syslogd
 2155 root      20   0    4484   1312   1212 S   0.0  0.1   0:00.01 klogd
 2183 root      20   0   18488   4764   4372 S   0.0  0.2   0:00.01 sshd
 2192 root      20   0   15224   1696   1520 S   0.0  0.1   0:00.05 cron
 2207 root       0 -20       0      0      0 S   0.0  0.0   0:00.00 l7comp
 2246 root      20   0    4464   1920   1724 S   0.0  0.1   0:00.21 l7d
 2323 root       8 -12    8748   3888   3748 S   0.0  0.2   0:01.12 ucarp
 2339 root      20   0    9532   2640   2428 S   0.0  0.1   0:00.00 startDaemon
 2344 root      20   0   11784   1908   1624 S   0.0  0.1   0:02.60 stats
 2364 root      20   0   23644   5512   4240 S   0.0  0.3   0:04.84 snmpd
 2375 root      20   0   11340   4448   2436 S   0.0  0.2   0:07.82 rrd-upd-al+
 2382 root      20   0    6504    124      0 S   0.0  0.0   0:00.35 inotifywait
 2430 root      20   0    9532   2664   2448 S   0.0  0.1   0:00.00 startDaemon
 2438 root      20   0   14060   3680   3248 S   0.0  0.2   0:00.09 ocspd
 2458 root      20   0    6724   1616   1500 S   0.0  0.1   0:00.02 httpd_ha
 2460 root      20   0    6724   1648   1532 S   0.0  0.1   0:00.47 httpd
 2483 root      20   0    9536   2700   2488 S   0.0  0.1   0:00.00 startDaemon
 2488 root      20   0   14348   5140   4400 S   0.0  0.2   0:00.61 sslproxy_ha
 2534 root      20   0    9536   2648   2432 S   0.0  0.1   0:00.00 startDaemon
 2541 root      20   0   16108   2952   2556 S   0.0  0.1   0:00.15 vsslproxy
 2567 root      20   0    9532   2644   2432 S   0.0  0.1   0:00.00 startDaemon
 2574 root      12  -8   17420   3244   2668 S   0.0  0.2   0:00.45 l4d
 2610 root      20   0    9532   2644   2436 S   0.0  0.1   0:00.00 startDaemon
 2615 root      20   0   52492   4132   3616 S   0.0  0.2   0:00.32 wafd
 2643 root      20   0    4668   1760   1396 S   0.0  0.1   0:00.01 binddb
 2661 root      20   0    5436    704    624 S   0.0  0.0   0:00.05 geocheck
 2664 root      20   0   98352  81536   5996 S   0.0  4.0   0:05.85 named
 2735 root      20   0   42728   4232   3708 S   0.0  0.2   0:08.21 vmtoolsd
 2781 root      20   0    8676   1656   1556 S   0.0  0.1   0:00.00 mingetty
 2782 root      20   0    8676   1736   1632 S   0.0  0.1   0:00.00 mingetty
 2783 root      20   0    8676   1676   1576 S   0.0  0.1   0:00.00 mingetty
 2784 root      20   0    8676   1652   1556 S   0.0  0.1   0:00.01 mingetty
 2785 root      20   0    8676   1656   1556 S   0.0  0.1   0:00.01 mingetty
 2786 root      20   0    8676   1644   1540 S   0.0  0.1   0:00.00 mingetty
 3948 root      20   0    6736    116      0 S   0.0  0.0   0:00.00 httpd
 3949 bal       20   0    9944    948    856 S   0.0  0.0   0:00.02 access
 3958 bal       20   0   11440   2012   1828 R   0.0  0.1   0:00.00 top
 6283 root      20   0    9536   2704   2488 S   0.0  0.1   0:00.00 startDaemon
 6292 root      20   0   14464   5120   4240 S   0.0  0.2   0:10.22 sslproxy
 7170 root      20   0       0      0      0 S   0.0  0.0   0:00.05 kworker/u4+
14327 root      20   0       0      0      0 Z   0.0  0.0   0:00.00 httpd_ha
21582 root      20   0       0      0      0 S   0.0  0.0   0:00.00 kworker/u4+
31933 root      20   0       0      0      0 S   0.0  0.0   0:00.00 kworker/u4+

                            

						

                        
Top of page
				

				

					

						
 Get-LmRaidController 

						
Display the Redundant Array of Independent Disks (RAID) controller details.

						
These details include the model name, serial number, capacity, state, status, level, and total members in the RAID.

					

                        

                        
 Syntax 

                        

						

                            


Get-LmRaidController [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Get-LmRaidController [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN <String>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Get-LmRaidController

							    
Example Output:
Return Code..: 200
Response.....: Command successfully executed.
Data field...: @{RaidController=System.Xml.XmlElement}
Param........: 

$lma.Data.RaidController

RaidController RaidPort
-------------- --------
RaidController RaidPort


$lma.Data.RaidController.RaidController

ChipID                : 10
ParentControllerIndex : 255
OSPhysicalName        : /dev/sda
SerialNumber          : 427491329
AESPowerOnState       : 0
SataPorts             : 2


$lma.Data.RaidController.RaidPort

ID                  : 0
ModelName           : H/W RAID1                               
SerialNumber        : 0LFQCNJHO38I9YHJHMEK
EZBackupDiskSupport : 0
PortMultiplier      : 0
RaidCapacity        : 14903 (465 GB)
RaidCapacityLowWord : 0
RaidState           : Active
RaidStatus          : Normal
RaidLevel           : Raid 1 (mirror)
MarkType            : 0
ActiveMember        : 15
ActiveLevel         : 0
RebuildPriority     : 3
StandbyTimer        : 0
TotalRaidMembers    : 2
MemberDisk          : {MemberDisk, MemberDisk}


$lma.Data.RaidController.RaidPort.MemberDisk

DiskId          : 0
Ready           : 1
Lba48BitSupport : 1
SATAPage        : 0
SATAPort        : 0
SATABase        : 0
SATASize        : 14903

DiskId          : 1
Ready           : 1
Lba48BitSupport : 1
SATAPage        : 0
SATAPort        : 1
SATABase        : 0
SATASize        : 14903

                            

						

                        
Top of page
				

				

					

						
 Get-LmRaidControllerDisk 

						
Display details about the Redundant Array of Independent Disks (RAID) disks.

						
Details include the model name, serial number, firmware version, capacity, type, and speed.

					

                        

                        
 Syntax 

                        

						

                            


Get-LmRaidControllerDisk [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Get-LmRaidControllerDisk [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN 
<String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Get-LmRaidControllerDisk

							    
Example Output:
Return Code..: 200
Response.....: Command successfully executed.
Data field...: @{RaidControllerDisk=System.Xml.XmlElement}
Param........: 

$lma2.Data.RaidControllerDisk

SataPort            
--------            
{SataPort, SataPort}


$lma2.Data.RaidControllerDisk.SataPort

ID                  : 0
ModelName           : WDC WD5000LUCT-63RC2Y0                  
SerialNumber        :      WD-WX71E87F3P1M
FirmwareVersion     : 01.01A01
EZBackupDiskSupport : 1
PortMultiplier      : 15
DiskCapacity        : 465 GB
PortType            : RAID
PortSpeed           : 2 (GB)
Page                : {Page, Page}
PortErrorStatus     : 0

ID                  : 1
ModelName           : WDC WD5000LUCT-63RC2Y0                  
SerialNumber        :      WD-WX71E87845R4
FirmwareVersion     : 01.01A01
EZBackupDiskSupport : 1
PortMultiplier      : 15
DiskCapacity        : 465 GB
PortType            : RAID
PortSpeed           : 2 (GB)
Page                : {Page, Page}
PortErrorStatus     : 0


$lma2.Data.RaidControllerDisk.SataPort[0]

ID                  : 0
ModelName           : WDC WD5000LUCT-63RC2Y0                  
SerialNumber        :      WD-WX71E87F3P1M
FirmwareVersion     : 01.01A01
EZBackupDiskSupport : 1
PortMultiplier      : 15
DiskCapacity        : 465 GB
PortType            : RAID
PortSpeed           : 2 (GB)
Page                : {Page, Page}
PortErrorStatus     : 0


$lma2.Data.RaidControllerDisk.SataPort[1]

ID                  : 1
ModelName           : WDC WD5000LUCT-63RC2Y0                  
SerialNumber        :      WD-WX71E87845R4
FirmwareVersion     : 01.01A01
EZBackupDiskSupport : 1
PortMultiplier      : 15
DiskCapacity        : 465 GB
PortType            : RAID
PortSpeed           : 2 (GB)
Page                : {Page, Page}
PortErrorStatus     : 0

                            

						

                        
Top of page
				

				

					

						
 Get-LmSyslogFile 

						
List the existing system log files.

						
Run this command to retrieve a list of the existing system log files.

					

                        

                        
 Syntax 

                        

						

                            


Get-LmSyslogFile [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction <ActionPreference>] 
[-InformationVariable <String>] [<CommonParameters>]

Get-LmSyslogFile [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN <String>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Get-LmSyslogFile

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed; Data=@{SyslogFiles=}}
Return Code..: 200
Response.....: Command successfully executed


File1   : lastlog
File2   : messages
File3   : messages-20170914.gz
File4   : messages-20170915.gz
File5   : messages-20170916.gz
File6   : messages-20170917.gz
File7   : messages-20170918.gz
File8   : messages-20170919.gz
File9   : messages-20170920.gz
File10  : messages-20170921.gz
File11  : messages-20170922.gz
File12  : messages-20170923.gz
File13  : messages-20170924.gz
File14  : messages-20170925.gz
File15  : messages-20170926.gz
File16  : messages-20170927.gz
File17  : messages-20170928.gz
File18  : messages-20170929.gz
File19  : messages-20170930.gz
File20  : messages-20171001.gz
File21  : messages-20171002.gz
File22  : messages-20171003.gz
File23  : messages-20171004.gz
File24  : messages-20171005.gz
File25  : messages-20171006.gz
File26  : messages-20171007.gz
File27  : messages-20171008.gz
File28  : messages-20171009.gz
File29  : messages-20171010.gz
File30  : messages-20171011.gz
File31  : messages-20171012.gz
File32  : messages-20171013.gz
File33  : messages-20171014.gz
File34  : messages-20171015.gz
File35  : messages-20171016.gz
File36  : messages-20171017.gz
File37  : messages-20171018.gz
File38  : messages-20171019.gz
File39  : messages-20180321.gz
File40  : messages-20180322.gz
File41  : messages-20180323.gz
File42  : messages-20180324.gz
File43  : messages-20180325.gz
File44  : messages-20180326.gz
File45  : messages-20180327.gz
File46  : messages-20180328.gz
File47  : messages-20180329.gz
File48  : messages-20180330.gz
File49  : messages-20180331.gz
File50  : messages-20180401.gz
File51  : messages-20180402.gz
File52  : messages-20180403.gz
File53  : messages-20180404.gz
File54  : messages-20180405.gz
File55  : messages-20180406.gz
File56  : messages-20180407.gz
File57  : messages-20180408.gz
File58  : messages-20180409.gz
File59  : messages-20180410.gz
File60  : messages-20180411.gz
File61  : messages-20180412.gz
File62  : messages-20180413.gz
File63  : messages-20180414.gz
File64  : messages-20180415.gz
File65  : messages-20180416.gz
File66  : messages-20180417.gz
File67  : messages-20180418.gz
File68  : messages-20180419.gz
File69  : messages-20180908.gz
File70  : named.log
File71  : rsyncd.log
File72  : rsyncd.log-20170920.gz
File73  : rsyncd.log-20170923.gz
File74  : rsyncd.log-20170926.gz
File75  : rsyncd.log-20170930.gz
File76  : rsyncd.log-20171003.gz
File77  : rsyncd.log-20171006.gz
File78  : rsyncd.log-20171010.gz
File79  : rsyncd.log-20171013.gz
File80  : rsyncd.log-20171016.gz
File81  : rsyncd.log-20171024.gz
File82  : rsyncd.log-20171027.gz
File83  : rsyncd.log-20171031.gz
File84  : rsyncd.log-20171103.gz
File85  : rsyncd.log-20171106.gz
File86  : rsyncd.log-20171110.gz
File87  : rsyncd.log-20171113.gz
File88  : rsyncd.log-20171117.gz
File89  : rsyncd.log-20171120.gz
File90  : rsyncd.log-20171123.gz
File91  : rsyncd.log-20171127.gz
File92  : rsyncd.log-20171130.gz
File93  : rsyncd.log-20171203.gz
File94  : rsyncd.log-20171207.gz
File95  : rsyncd.log-20171210.gz
File96  : rsyncd.log-20171213.gz
File97  : rsyncd.log-20171217.gz
File98  : rsyncd.log-20171220.gz
File99  : rsyncd.log-20171223.gz
File100 : rsyncd.log-20171227.gz
File101 : rsyncd.log-20171230.gz
File102 : rsyncd.log-20180102.gz
File103 : rsyncd.log-20180323.gz
File104 : rsyncd.log-20180326.gz
File105 : rsyncd.log-20180330.gz
File106 : rsyncd.log-20180402.gz
File107 : rsyncd.log-20180405.gz
File108 : rsyncd.log-20180409.gz
File109 : rsyncd.log-20180412.gz
File110 : rsyncd.log-20180415.gz
File111 : rsyncd.log-20180419.gz
File112 : rsyncd.log-20180723.gz
File113 : rsyncd.log-20180726.gz
File114 : rsyncd.log-20180730.gz
File115 : rsyncd.log-20180802.gz
File116 : rsyncd.log-20180805.gz
File117 : rsyncd.log-20180809.gz
File118 : rsyncd.log-20180812.gz
File119 : rsyncd.log-20180815.gz
File120 : rsyncd.log-20180819.gz
File121 : rsyncd.log-20180822.gz
File122 : rsyncd.log-20180825.gz
File123 : rsyncd.log-20180829.gz
File124 : rsyncd.log-20180901.gz
File125 : rsyncd.log-20180904.gz
File126 : rsyncd.log-20180908.gz
File127 : rsyncd.log-20180911.gz
File128 : rsyncd.log-20180914.gz
File129 : rsyncd.log-20180918.gz
File130 : waf.debug
File131 : wafeventlog
File132 : warn
File133 : warn-20180322.gz
File134 : warn-20180323.gz
File135 : warn-20180324.gz
File136 : warn-20180325.gz
File137 : warn-20180326.gz
File138 : warn-20180327.gz
File139 : warn-20180328.gz
File140 : warn-20180329.gz
File141 : warn-20180330.gz
File142 : warn-20180331.gz
File143 : warn-20180401.gz
File144 : warn-20180402.gz
File145 : warn-20180403.gz
File146 : warn-20180404.gz
File147 : warn-20180405.gz
File148 : warn-20180406.gz
File149 : warn-20180407.gz
File150 : warn-20180408.gz
File151 : warn-20180409.gz
File152 : warn-20180410.gz
File153 : warn-20180411.gz
File154 : warn-20180412.gz
File155 : warn-20180413.gz
File156 : warn-20180414.gz
File157 : warn-20180415.gz
File158 : warn-20180416.gz
File159 : warn-20180417.gz
File160 : warn-20180418.gz
File161 : warn-20180419.gz
File162 : warn-20181107.gz

                            

						

                        
Top of page
				

				

					

						
 Get-LmVpnConnection 

						
Retrieves a list of all existing Virtual Private Network (VPN) connection details, or details for a specific VPN connection.

						
To retrieve details for a specific VPN connection, use the Name parameter to specify the name of the relevant VPN 
connection. To retrieve details for all VPN connections, do not use the Name parameter.

					

                        

                        
 Syntax 

                        

						

                            


Get-LmVpnConnection [-Name <String>] [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Get-LmVpnConnection [-Name <String>] [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] 
[-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-Name
                                        
										Specify the name of a specific VPN connection to display the details for. To display details for all VPN connections - do 
not use this parameter.		
										false
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Get-LmVpnConnection

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.
Data field...: @{VpnConfiguration=}
Param........: @{name=ExampleVPN; status=Down; localIP=10.35.47.15; localSubnets=10.35.47.15/32; remoteIP=; remoteSubnets=; 
localID=10.35.47.15; remoteI
D=; key=; pfs=disabled}


name          : ExampleVPN
status        : Down
localIP       : 10.35.47.15
localSubnets  : 10.35.47.15/32
remoteIP      : 
remoteSubnets : 
localID       : 10.35.47.15
remoteID      : 
key           : 
pfs           : disabled

                            

						

                        
Top of page
				

				

					

						
 Get-LmVpnIkeDaemonStatus 

						
View the status of the Internet Key Exchange (IKE) daemon.

						
Run this command to check the status of the IKE daemon.

					

                        

                        
 Syntax 

                        

						

                            


Get-LmVpnIkeDaemonStatus [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Get-LmVpnIkeDaemonStatus [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN 
<String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Get-LmVpnIkeDaemonStatus

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.
Data field...: @{IkeDaemonStatus=Down}

                            

						

                        
Top of page
				

				

					

						
 Get-LmWuiSetting 

						
Retrieve the LoadMaster Web User Interface (WUI) settings.

						
This command returns the WUI settings, such as the Message of the Day and the Statistics Display Size.

					

                        

                        
 Syntax 

                        

						

                            


Get-LmWuiSetting [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction <ActionPreference>] 
[-InformationVariable <String>] [<CommonParameters>]

Get-LmWuiSetting [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN <String>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Get-LmWuiSetting

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.
Data field...: @{Parameters=}
Param........: @{motd=Example Message of the Day; hoverhelp=no}

                            

						

                        
Top of page
				

				

					

						
 Get-LogEmailConfiguration 

						
Allows you to view the values of the email logging options.

						
Allows you to view the values of the email logging options.

					

                        

                        
 Syntax 

                        

						

                            


Get-LogEmailConfiguration [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Get-LogEmailConfiguration [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN 
<String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Get-LogEmailConfiguration

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed; Data=}
Return Code..: 200
Response.....: Command successfully executed
Data field...: @{EmailConfiguration=}
Param........: @{EmailEnable=yes; EmailServer=10.154.22.132; EmailPort=80; EmailUser=test; EmailPassword=********; 
EmailDomain=ExampleDomain; EmailSSLMo
de=1; EmailEmergency=; EmailCritical=; EmailError=; EmailWarn=; EmailNotice=; EmailInfo=}


EmailEnable    : yes
EmailServer    : 10.154.22.132
EmailPort      : 80
EmailUser      : test
EmailPassword  : ********
EmailDomain    : ExampleDomain
EmailSSLMode   : 1
EmailEmergency : 
EmailCritical  : 
EmailError     : 
EmailWarn      : 
EmailNotice    : 
EmailInfo      :

                            

						

                        
Top of page
				

				

					

						
 Get-LogSplitInterval 

						
WARNING: This function is deprecated. Use the following command instead:
Get-AdcL7LogInsightSplitConfiguration

						
WARNING: This function is deprecated. Use the following command instead:
Get-AdcL7LogInsightSplitConfiguration

					

                        

                        
 Syntax 

                        

						

                            


Get-LogSplitInterval [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Get-LogSplitInterval [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN <String>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-LoadBalancer
                                        
										
										false
										false
										
									

									

										-LBPort
                                        
										
										false
										false
										
									

									

										-Credential
                                        
										
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										
										false
										false
										
									

									

										-SubjectCN
                                        
										
										false
										false
										
									

								
							

						
				
				

				

					

						
 Get-LogStatistics 

						
Returns statistics and some settings for each of the services.

						
Returns statistics and some settings for each of the services.

					

                        

                        
 Syntax 

                        

						

                            


Get-LogStatistics [-VirtualService <SwitchParameter>] [-RealServer <SwitchParameter>] [-Totals <SwitchParameter>] 
[-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction <ActionPreference>] 
[-InformationVariable <String>] [<CommonParameters>]

Get-LogStatistics [-VirtualService <SwitchParameter>] [-RealServer <SwitchParameter>] [-Totals <SwitchParameter>] 
[-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN <String>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-VirtualService
                                        
										Enable this option to only retrieve statistics for Virtual Services.
										false
										false
										
									

									

										-RealServer
                                        
										Enable this option to only retrieve statistics for Real Servers on the LoadMaster.
										false
										false
										
									

									

										-Totals
                                        
										Enable this to get all statistics from the LoadMaster.
										false
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
						

                            

                                
 Note 

                            

							
If you run the Get-Statistics command on the admin node when using LoadMaster clustering – the output will show the 
    combined totals of all machines.

						

                        

                            
 Examples 

                        

						

                            

							    Example

Get-LogStatistics

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.
Data field...: @{Vs=; Rs=; VStotals=; CPU=; Network=; Memory=; DiskUsage=; TPS=; ChangeTime=15...
Vs         : 
Rs         : 
VStotals   : @{ConnsPerSec=0; TotalConns=0; BitsPerSec=0; TotalBits=0; BytesPerSec=0; TotalBytes=0; PktsPerSec=0; 
             TotalPackets=0}
CPU        : @{total=; cpu0=; cpu1=}
Network    : @{eth0=}
Memory     : @{memused=305880; percentmemused=14; memfree=1750684; percentmemfree=86}
DiskUsage  : @{partition=System.Object[]}
TPS        : @{Total=0; SSL=0}
ChangeTime : 1550578681

                            

						

                        
Top of page
				

				

					

						
 Get-LogSyslogConfiguration 

						
Allows you to view which hosts the various Syslog messages get sent to.

						
Allows you to view which hosts the various Syslog messages get sent to.

					

                        

                        
 Syntax 

                        

						

                            


Get-LogSyslogConfiguration [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Get-LogSyslogConfiguration [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN 
<String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Get-LogSyslogConfiguration

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed; Data=}
Return Code..: 200
Response.....: Command successfully executed
Data field...: @{SyslogSettings=}
Param........: @{SyslogEmergency=; SyslogCritical=; SyslogError=; SyslogWarn=; SyslogNotice=; SyslogInfo=10.154.153.94; 
SyslogPort=60}
SyslogEmergency : 
SyslogCritical  : 
SyslogError     : 
SyslogWarn      : 
SyslogNotice    : 
SyslogInfo      : 10.154.153.94
SyslogPort      : 60

                            

						

                        
Top of page
				

				

					

						
 Get-NetworkConfiguration 

						
Allows you to view the values of some networking options.

						
Allows you to view the values of some networking options.

					

                        

                        
 Syntax 

                        

						

                            


Get-NetworkConfiguration [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Get-NetworkConfiguration [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN 
<String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
						

                            

                                
 Note 

                            

							
This is a legacy command and does not return all of the available parameters. Please refer to the Get-Help of the 
    Get-Parameter command to view a full list of parameters that can be returned.

						

                        

                            
 Examples 

                        

						

                            

							    Example

Get-NetworkConfiguration

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.
Data field...: @{NetworkConfiguration=}
Param........: @{snat=yes; allowupload=no; conntimeout=660; keepalive=yes; multigw=no; nonlocalrs=no; onlydefaultroutes=no; 
resetclose=no; subnetorigin=
yes; subnetoriginating=yes; tcptimestamp=no; routefilter=no; dhkeysize=2048; http_proxy=}
snat              : yes
allowupload       : no
conntimeout       : 660
keepalive         : yes
multigw           : no
nonlocalrs        : no
onlydefaultroutes : no
resetclose        : no
subnetorigin      : yes
subnetoriginating : yes
tcptimestamp      : no
routefilter       : no
dhkeysize         : 2048
http_proxy        :

                            

						

                        
Top of page
				

				

					

						
 Get-NetworkDNSConfiguration 

						
Allows you to retrieve the values of the DNS Configuration options.

						
Allows you to retrieve the values of the DNS Configuration options.

					

                        

                        
 Syntax 

                        

						

                            


Get-NetworkDNSConfiguration [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Get-NetworkDNSConfiguration [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN 
<String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
						

                            

                                
 Note 

                            

							
This is a legacy command and does not return all of the available parameters. Please refer to the Get-Help of the 
    Get-Parameter command to view a full list of parameters that can be returned.

						

                        

                            
 Examples 

                        

						

                            

							    Example

Get-NetworkDNSConfiguration

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.
Data field...: @{NetworkDNSConfiguration=}
Param........: @{Hostname=lb100; NamServer=10.154.75.25; SearchList= Kemp.LAB.INTRA}
Hostname   : lb100
NamServer  : 10.154.75.25
SearchList :  Kemp.LAB.INTRA

                            

						

                        
Top of page
				

				

					

						
 Get-NetworkInterface 

						
Retreive details about all interfaces or a specific interface.

						
Specify the InterfaceID to retreive details for a particular interface. Otherwise, all interface details are displayed.

					

                        

                        
 Syntax 

                        

						

                            


Get-NetworkInterface [-InterfaceID <Int16>] [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Get-NetworkInterface [-InterfaceID <Int16>] [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] 
[-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-InterfaceID
                                        
										The Interface ID to get settings for. If this parameter is omitted, it will default to eth0.
To view the interface ID for each of the interfaces, run the Get-Statistics command. The interface ID is the first number 
displayed in each interface row.		
										false
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Get-NetworkInterface

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.
Id               : 0
IPAddress        : 10.154.11.180/16
Mtu              : 1500
InterfaceType    : Port
GeoTrafficEnable : yes
DefaultInterface : yes

Id               : 1
IPAddress        : 10.154.11.180/16
Mtu              : 1500
InterfaceType    : Port
GeoTrafficEnable : no
DefaultInterface : no

                            

						

                        
Top of page
				

				

					

						
 Get-NetworkOptions 

						
WARNING: This function is deprecated. Use the following command instead:
Get-NetworkConfiguration

						
WARNING: This function is deprecated. Use the following command instead:
Get-NetworkConfiguration

					

                        

                        
 Syntax 

                        

						

                            


Get-NetworkOptions [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Get-NetworkOptions [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN <String>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-LoadBalancer
                                        
										
										false
										false
										
									

									

										-LBPort
                                        
										
										false
										false
										
									

									

										-Credential
                                        
										
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										
										false
										false
										
									

									

										-SubjectCN
                                        
										
										false
										false
										
									

								
							

						
				
				

				

					

						
 Get-NetworkRoute 

						
Allows you to view the details of all Additional Routes.

						
Allows you to view the details of all Additional Routes.

					

                        

                        
 Syntax 

                        

						

                            


Get-NetworkRoute [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction <ActionPreference>] 
[-InformationVariable <String>] [<CommonParameters>]

Get-NetworkRoute [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN <String>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Get-NetworkRoute

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.
Route : @{Destination=10.154.11.24/32; Gateway=10.154.2.32}

                            

						

                        
Top of page
				

				

					

						
 Get-NetworkSNMPConfiguration 

						
Allows you to view the values of the various SNMP options.

						
Allows you to view the values of the various SNMP options.

					

                        

                        
 Syntax 

                        

						

                            


Get-NetworkSNMPConfiguration [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Get-NetworkSNMPConfiguration [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN 
<String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Get-NetworkSNMPConfiguration

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed; Data=}
Return Code..: 200
Response.....: Command successfully executed
SNMPEnable     : yes
SNMPv3enable   : no
SNMPClient     : 
SNMPCommunity  : 
SNMPContact    : 
SNMPLocation   : 
SNMPTrapEnable : no

                            

						

                        
Top of page
				

				

					

						
 Get-PacketFilterOptionACL 

						
Retrieves the value of the Packet Routing Filter option.

						
Retrieves the value of the Packet Routing Filter option. This can also be used to determine whether packet filtering is 
enabled.

					

                        

                        
 Syntax 

                        

						

                            


Get-PacketFilterOptionACL [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Get-PacketFilterOptionACL [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN 
<String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Get-PacketFilterOptionACL

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.
Data field...: @{PacketFilterConfiguration=}
Param........: @{aclstatus=enable; aclmethod=reply; aclblockall=free}

                            

						

                        
Top of page
				

				

					

						
 Get-Parameter 

						
WARNING: This function is deprecated. Use the following command instead:
Get-LmParameter

						
WARNING: This function is deprecated. Use the following command instead:
Get-LmParameter

					

                        

                        
 Syntax 

                        

						

                            


Get-Parameter -Param <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Get-Parameter -Param <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN 
<String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-Param
                                        
										
										true
										false
										
									

									

										-LoadBalancer
                                        
										
										false
										false
										
									

									

										-LBPort
                                        
										
										false
										false
										
									

									

										-Credential
                                        
										
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										
										false
										false
										
									

									

										-SubjectCN
                                        
										
										false
										false
										
									

								
							

						
				
				

				

					

						
 Get-RealServer 

						
WARNING: This function is deprecated. Use the following command instead:
Get-AdcRealServer

						
WARNING: This function is deprecated. Use the following command instead:
Get-AdcRealServer

					

                        

                        
 Syntax 

                        

						

                            


Get-RealServer [-VirtualService <String>] [-VSPort <Int32>] [-VSProtocol <String>] [-VSIndex <Int32>] [-RealServer 
<String>] [-RSPort <Int32>] [-RSIndex <Int32>] [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Get-RealServer [-VirtualService <String>] [-VSPort <Int32>] [-VSProtocol <String>] [-VSIndex <Int32>] [-RealServer 
<String>] [-RSPort <Int32>] [-RSIndex <Int32>] [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation 
<String>] [-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-VirtualService
                                        
										
										false
										false
										
									

									

										-VSPort
                                        
										
										false
										false
										
									

									

										-VSProtocol
                                        
										
										false
										false
										
									

									

										-VSIndex
                                        
										
										false
										false
										
									

									

										-RealServer
                                        
										
										false
										false
										
									

									

										-RSPort
                                        
										
										false
										false
										
									

									

										-RSIndex
                                        
										
										false
										false
										
									

									

										-LoadBalancer
                                        
										
										false
										false
										
									

									

										-LBPort
                                        
										
										false
										false
										
									

									

										-Credential
                                        
										
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										
										false
										false
										
									

									

										-SubjectCN
                                        
										
										false
										false
										
									

								
							

						
				
				

				

					

						
 Get-Route 

						
WARNING: This function is deprecated. Use the following command instead:
Get-NetworkRoute

						
WARNING: This function is deprecated. Use the following command instead:
Get-NetworkRoute

					

                        

                        
 Syntax 

                        

						

                            


Get-Route [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction <ActionPreference>] 
[-InformationVariable <String>] [<CommonParameters>]

Get-Route [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN <String>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-LoadBalancer
                                        
										
										false
										false
										
									

									

										-LBPort
                                        
										
										false
										false
										
									

									

										-Credential
                                        
										
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										
										false
										false
										
									

									

										-SubjectCN
                                        
										
										false
										false
										
									

								
							

						
				
				

				

					

						
 Get-Rule 

						
WARNING: This function is deprecated. Use the following command instead:
Get-AdcContentRule

						
WARNING: This function is deprecated. Use the following command instead:
Get-AdcContentRule

					

                        

                        
 Syntax 

                        

						

                            


Get-Rule [-RuleName <String>] [-RuleType <String>] [-All <SwitchParameter>] [-LoadBalancer <String>] [-LBPort <Int32>] 
[-Credential <Object>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Get-Rule [-RuleName <String>] [-RuleType <String>] [-All <SwitchParameter>] [-LoadBalancer <String>] [-LBPort <Int32>] 
[-CertificateStoreLocation <String>] [-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable 
<String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-RuleName
                                        
										
										false
										false
										
									

									

										-RuleType
                                        
										
										false
										false
										
									

									

										-All
                                        
										
										false
										false
										
									

									

										-LoadBalancer
                                        
										
										false
										false
										
									

									

										-LBPort
                                        
										
										false
										false
										
									

									

										-Credential
                                        
										
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										
										false
										false
										
									

									

										-SubjectCN
                                        
										
										false
										false
										
									

								
							

						
				
				

				

					

						
 Get-SAMLDomain 

						
Retrieve details about the specified SAML SSO domain.

						
Retrieve the parameter values for a SAML SSO domain.

					

                        

                        
 Syntax 

                        

						

                            


Get-SAMLDomain [-Domain <String>] [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Get-SAMLDomain [-Domain <String>] [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] 
[-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-Domain
                                        
										The name of the SAML SSO domain to retrieve the details for. If the Domain is not specified, the command returns all the 
available SAML domains.		
										false
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Get-SAMLDomain

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.
Data field...: @{Domain=System.Object[]}
Param........: 
Id                     : 9
Name                   : EXAMPLE2.COM
server                 : 10.154.45.22
auth_type              : SAML
idp_entity_id          : 
idp_sso_url            : 
idp_logoff_url         : 
idp_cert               : 
sp_entity_id           : idp-3.example.com
sp_cert                : UseSelfSigned
sess_tout_type         : idle time
sess_tout_idle_pub     : 900
sess_tout_duration_pub : 1800

                            

						

                        
Top of page
				

				

					

						
 GetSDNController 

						
WARNING: This function is deprecated. Use the following command instead:
Get-SdnController

						
WARNING: This function is deprecated. Use the following command instead:
Get-SdnController

					

                        

                        
 Syntax 

                        

						

                            


GetSDNController [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction <ActionPreference>] 
[-InformationVariable <String>] [<CommonParameters>]

GetSDNController [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN <String>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-LoadBalancer
                                        
										
										false
										false
										
									

									

										-LBPort
                                        
										
										false
										false
										
									

									

										-Credential
                                        
										
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										
										false
										false
										
									

									

										-SubjectCN
                                        
										
										false
										false
										
									

								
							

						
				
				

				

					

						
 Get-SdnController 

						
WARNING: This function is deprecated. Use the following command instead:
Get-SdnController

						
WARNING: This function is deprecated. Use the following command instead:
Get-SdnController

					

                        

                        
 Syntax 

                        

						

                            


Get-SdnController [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction <ActionPreference>] 
[-InformationVariable <String>] [<CommonParameters>]

Get-SdnController [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN <String>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Get-SdnController

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=Data}
Return Code..: 200
Response.....: Command successfully executed.
Param........: cluster cluster

id controller
-- ----------
1  controller
3  controller

                            

						

                        
Top of page
				

				

					

						
 Get-SecAdminAccess 

						
Retrieve the admin access settings.

						
This command returns the admin access settings (WuiDefaultGateway, WuiNetworkInterfaceId, WuiPort).

					

                        

                        
 Syntax 

                        

						

                            


Get-SecAdminAccess [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Get-SecAdminAccess [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN <String>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Get-SecAdminAccess

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.
Data field...: @{SecAdminAccessConfiguration=}
Param........: @{WuiDefaultGateway=; WuiNetworkInterfaceId=0; WuiPort=443}

                            

						

                        
Top of page
				

				

					

						
 Get-SecAdminWuiConfiguration 

						
Retrieve the admin Web User Interface (WUI) access settings.

						
Displays these settings, including the supported TLS protocols and WUI cipher set.

					

                        

                        
 Syntax 

                        

						

                            


Get-SecAdminWuiConfiguration [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Get-SecAdminWuiConfiguration [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN 
<String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Get-SecAdminWuiConfiguration

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.
Data field...: @{SecAdminWuiConfiguration=}
Param........: @{WUITLSProtocols=0; WUICipherset=; sessioncontrol=yes; sessionbasicauth=no; sessionmaxfailattempts=0; 
sessionidletime=0; sessionconcurre
nt=0; wuipreauth=}

                            

						

                        
Top of page
				

				

					

						
 Get-SecRemoteAccess 

						
Allows you to view Remote Access options.

						
Allows you to view Remote Access options.

					

                        

                        
 Syntax 

                        

						

                            


Get-SecRemoteAccess [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Get-SecRemoteAccess [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN <String>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
						

                            

                                
 Note 

                            

							
This is a legacy command and does not return all of the available parameters. Please refer to the Get-Help of the 
    Get-Parameter command to view a full list of parameters that can be returned.

						

                        

                            
 Examples 

                        

						

                            

							    Example

Get-SecRemoteAccess

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.
Param........: @{sshaccess=yes; sshiface=all; sshport=22; wuiaccess=yes; enableapi=yes; geoclients=; 
geopartners=10.154.11.190; geosshport=22; geosshifa
ce=0; MultiHomedWui=no; SSHPreAuthBanner=; AllowUpdateChecks=yes}

                            

						

                        
Top of page
				

				

					

						
 Get-SecRemoteAccessLoginMethod 

						
Retrieve the Admin Login Method.

						
This command returns the Admin Login Method for the WUI, for example, "Password or Client certificate" or "Password Only 
Access (default)".

					

                        

                        
 Syntax 

                        

						

                            


Get-SecRemoteAccessLoginMethod [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Get-SecRemoteAccessLoginMethod [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN 
<String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Get-SecRemoteAccessLoginMethod

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.
Data field...: @{LoginMethod=PasswordOrClientCertificate}
Param........: PasswordOrClientCertificate
PasswordOrClientCertificate

                            

						

                        
Top of page
				

				

					

						
 Get-SecRemoteUserGroup 

						
Retreive details of all remote user groups, or a specific group.

						
Enter a group name in the Group parameter to retrieve details for a specific group. Alternatively, exclude the Group 
parameter to retrieve a full list of all groups.

					

                        

                        
 Syntax 

                        

						

                            


Get-SecRemoteUserGroup [-Group <String>] [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Get-SecRemoteUserGroup [-Group <String>] [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] 
[-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-Group
                                        
										To retrieve details for a specific group, enter the group name in the Group parameter.
										false
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Get-SecRemoteUserGroup

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.;Data=RemoteGroupSettings=System.Object[]}
Return Code..: 200
Response.....: Command successfully executed.

Name                   Perms                         
----                   -----                         
ExampleGroup2          certs,cert3,certbackup        
ExampleRemoteUserGroup real,vs,certs,cert3,certbackup
ExampleGroup3          real,vs,geo

                            

						

                        
Top of page
				

				

					

						
 Get-SecUser 

						
Displays permissions for a user, or users.

						
Specifying a username for the User parameter displays details for that partiular user. Omitting the User parameter will 
return details for all users.

					

                        

                        
 Syntax 

                        

						

                            


Get-SecUser [-User <String>] [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Get-SecUser [-User <String>] [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN 
<String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-User
                                        
										Username of the relevant user. If this parameter is omitted, permissions for all users will be returned.
										false
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Get-SecUser

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.

Name                           Perms
----                           -----
Example                             
K360Central_10.154.172.215_158 root 
K360Central_10.154.153.94_14   root 
example2

                            

						

                        
Top of page
				

				

					

						
 Get-SecWuiAuthentication 

						
View the values of WUI Authentication and Authorization options.

						
Returns details such as the RADIUS configuration.

					

                        

                        
 Syntax 

                        

						

                            


Get-SecWuiAuthentication [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Get-SecWuiAuthentication [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN 
<String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Get-SecWuiAuthentication

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.
Data field...: @{SecWuiAuthenticationConfiguration=}
Param........: @{radiusserver=10.154.11.80; radiusport=80; radiussecret=********; radiusrevalidateinterval=60; 
radiusbackupserver=; radiusbackupport=0; radiusbackupsecret=********; wuildapep=EXAMPLE; wu...
radiusserver             : 10.154.11.80
radiusport               : 80
radiussecret             : ********
radiusrevalidateinterval : 60
radiusbackupserver       : 
radiusbackupport         : 0
radiusbackupsecret       : ********
wuildapep                : EXAMPLE
wuiusergroups            : 
wuinestedgroups          : no
sessionlocalauth         : no
sessionauthmode          : 771

                            

						

                        
Top of page
				

				

					

						
 Get-ServiceHealth 

						
WARNING: This function is deprecated. Use the following command instead:
Get-AdcServiceHealth

						
WARNING: This function is deprecated. Use the following command instead:
Get-AdcServiceHealth

					

                        

                        
 Syntax 

                        

						

                            


Get-ServiceHealth [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction <ActionPreference>] 
[-InformationVariable <String>] [<CommonParameters>]

Get-ServiceHealth [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN <String>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-LoadBalancer
                                        
										
										false
										false
										
									

									

										-LBPort
                                        
										
										false
										false
										
									

									

										-Credential
                                        
										
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										
										false
										false
										
									

									

										-SubjectCN
                                        
										
										false
										false
										
									

								
							

						
				
				

				

					

						
 Get-SNMPOption 

						
WARNING: This function is deprecated. Use the following command instead:
Get-NetworkSNMPConfiguration

						
WARNING: This function is deprecated. Use the following command instead:
Get-NetworkSNMPConfiguration

					

                        

                        
 Syntax 

                        

						

                            


Get-SNMPOption [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction <ActionPreference>] 
[-InformationVariable <String>] [<CommonParameters>]

Get-SNMPOption [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN <String>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-LoadBalancer
                                        
										
										false
										false
										
									

									

										-LBPort
                                        
										
										false
										false
										
									

									

										-Credential
                                        
										
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										
										false
										false
										
									

									

										-SubjectCN
                                        
										
										false
										false
										
									

								
							

						
				
				

				

					

						
 Get-SSODomain 

						
Returns a list of any SSO domains that exist and their settings.

						
Returns a list of any SSO domains that exist and their settings.

					

                        

                        
 Syntax 

                        

						

                            


Get-SSODomain [-Domain <String>] [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Get-SSODomain [-Domain <String>] [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] 
[-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-Domain
                                        
										To retrieve details about a particular domain, specify the domain name using this parameter.
										false
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Get-SSODomain

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.
Param........: @{Id=9; Name=EXAMPLE2.COM; testuser=; ldap_version=3; server_side=0; auth_type=RSA-SECURID; 
logon_fmt=Principalname; logon_fmt2=Principal
name; logon_transcode=1; logon_domain=; idp_entity_id=; idp_sso_url=; idp_logoff_url=; idp_cert=; sp_entity_id=; 
sp_cert=UseSelfSigned; kerberos_domain=
; kerberos_kdc=; kcd_username=; max_failed_auths=0; reset_fail_tout=60; unblock_tout=1800; sess_tout_type=idle time; 
sess_tout_idle_pub=900; sess_tout_d
uration_pub=1800; sess_tout_idle_priv=900; sess_tout_duration_priv=28800; cert_check_asi=0; cert_check_cn=0}


Id                      : 9
Name                    : EXAMPLE2.COM
testuser                : 
ldap_version            : 3
server_side             : 0
auth_type               : RSA-SECURID
logon_fmt               : Principalname
logon_fmt2              : Principalname
logon_transcode         : 1
logon_domain            : 
idp_entity_id           : 
idp_sso_url             : 
idp_logoff_url          : 
idp_cert                : 
sp_entity_id            : 
sp_cert                 : UseSelfSigned
kerberos_domain         : 
kerberos_kdc            : 
kcd_username            : 
max_failed_auths        : 0
reset_fail_tout         : 60
unblock_tout            : 1800
sess_tout_type          : idle time
sess_tout_idle_pub      : 900
sess_tout_duration_pub  : 1800
sess_tout_idle_priv     : 900
sess_tout_duration_priv : 28800
cert_check_asi          : 0
cert_check_cn           : 0

                            

						

                        
Top of page
				

				

					

						
 Get-SSODomainLockedUser 

						
Displays a list of users who are currently blocked from accessing the SSO domain.

						
Displays a list of users who are currently blocked from accessing the SSO domain.

					

                        

                        
 Syntax 

                        

						

                            


Get-SSODomainLockedUser [-Domain <String>] [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Get-SSODomainLockedUser [-Domain <String>] [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] 
[-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-Domain
                                        Name
										The name of the SSO domain.
										false
										true (ByValue)
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Get-SSODomainLockedUser -Domain example2.com

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.
Data field...: @{LockedUsers=}
Param........: @{domainid=1; user=ruth@qasp.com; locktime=Mon Apr 24 13:38:14 2017}
domainid : 1
user     : ruth@qasp.com
locktime : Mon Apr 24 13:38:14 2017

                            

						

                        
Top of page
				

				

					

						
 Get-SSODomainSession 

						
Retrieve details of an open SSO domain session, or sessions.

						
Retrieve details of an open SSO domain session, or sessions.

					

                        

                        
 Syntax 

                        

						

                            


Get-SSODomainSession -Domain <String> [-User <String>] [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Get-SSODomainSession -Domain <String> [-User <String>] [-LoadBalancer <String>] [-LBPort <Int32>] 
[-CertificateStoreLocation <String>] [-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable 
<String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-Domain
                                        Name
										Specify the name of the SSO domain to retrieve the details for.
										true
										false
										
									

									

										-User
                                        
										To retrieve a list of all open sessions for the specified SSO domain, leave this parameter blank. To narrow down the list 
to only retrieve sessions for a particular user, specify the username here.		
										false
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Get-SSODomainSession -Domain qasp.com

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.
Data field...: @{SSOSession=}
Param........: @{NumberOfSessions=1; Session=}
NumberOfSessions : 1
Session          : @{User=ruth@qasp.com; Client=10.0.70.230:40696; Destination=172.20.0.125; Created=2017-04-24 13:16:03; 
Expires=2017-04-24 13:46:03; 
                   Cookie=-}

                            

						

                        
Top of page
				

				

					

						
 Get-Statistics 

						
WARNING: This function is deprecated. Use the following command instead:
Get-LogStatistics

						
WARNING: This function is deprecated. Use the following command instead:
Get-LogStatistics

					

                        

                        
 Syntax 

                        

						

                            


Get-Statistics [-VirtualService <SwitchParameter>] [-RealServer <SwitchParameter>] [-Totals <SwitchParameter>] 
[-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction <ActionPreference>] 
[-InformationVariable <String>] [<CommonParameters>]

Get-Statistics [-VirtualService <SwitchParameter>] [-RealServer <SwitchParameter>] [-Totals <SwitchParameter>] 
[-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN <String>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-VirtualService
                                        
										
										false
										false
										
									

									

										-RealServer
                                        
										
										false
										false
										
									

									

										-Totals
                                        
										
										false
										false
										
									

									

										-LoadBalancer
                                        
										
										false
										false
										
									

									

										-LBPort
                                        
										
										false
										false
										
									

									

										-Credential
                                        
										
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										
										false
										false
										
									

									

										-SubjectCN
                                        
										
										false
										false
										
									

								
							

						
				
				

				

					

						
 Get-SyslogOption 

						
WARNING: This function is deprecated. Use the following command instead:
Get-LogSyslogConfiguration

						
WARNING: This function is deprecated. Use the following command instead:
Get-LogSyslogConfiguration

					

                        

                        
 Syntax 

                        

						

                            


Get-SyslogOption [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction <ActionPreference>] 
[-InformationVariable <String>] [<CommonParameters>]

Get-SyslogOption [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN <String>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-LoadBalancer
                                        
										
										false
										false
										
									

									

										-LBPort
                                        
										
										false
										false
										
									

									

										-Credential
                                        
										
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										
										false
										false
										
									

									

										-SubjectCN
                                        
										
										false
										false
										
									

								
							

						
				
				

				

					

						
 Get-Template 

						
Retrieve a list of installed templates.

						
This command will return a list of templates and related details.

					

                        

                        
 Syntax 

                        

						

                            


Get-Template [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction <ActionPreference>] 
[-InformationVariable <String>] [<CommonParameters>]

Get-Template [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN <String>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Get-Template

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.
Data field...: @{name=TFTP; comment=Handles TFTP over port 69 (Version 1.0); certified=yes}

                            

						

                        
Top of page
				

				

					

						
 Get-TlsCertificate 

						
List the currently installed certificates and their fingerprints.

						
A list of certificates and fingerprints is displayed.

					

                        

                        
 Syntax 

                        

						

                            


Get-TlsCertificate [-CertName <String>] [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Get-TlsCertificate [-CertName <String>] [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] 
[-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-CertName
                                        
										To retreive details for a particular certificate, specify the name using the CertName parameter.
										false
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-Outform
                                        
										Specify the format - either PEM or DER. DER is Base64-encoded because it is a binary format.
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Get-TlsCertificate

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.

name         modulus                                                                                                        
                           
----         -------                                                                                                        
                           
Example      C89E5A8F8B1FCD8F366D3DE3350B17BA44A18892DECE87B1149F26B849BA9581EFC281FBC9584F763430EF3EAC42E9F63866080766070A6
0C9314F10C0A07D3CE833928...
2            C89E5A8F8B1FCD8F366D3DE3350B17BA44A18892DECE87B1149F26B849BA9581EFC281FBC9584F763430EF3EAC42E9F63866080766070A6
0C9314F10C0A07D3CE833928...
ExampleCert2 C89E5A8F8B1FCD8F366D3DE3350B17BA44A18892DECE87B1149F26B849BA9581EFC281FBC9584F763430EF3EAC42E9F63866080766070A6
0C9314F10C0A07D3CE833928...

							    Example 2


							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.

name    type publickey                                                                                                      
             
----    ---- ---------                                                                                                      
             
ecccert ECC  
MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAExIIYNDHXTHHOGxWcQlNjXMwnBlZNvaEp4V4o+0yUBILnf7+hEZjbTKxfAPTiBechmEe6LNapZH6M0HK8lAsG+g==

name           type modulus
----           ---- -------                   
rsacertificate RSA  EBABCF2255B7E3A784E0122057E75E5902DAD385868A405775BE6641E343E1FED9B484FD3EA0ACA6C7EBA301EDD4AAC2BA32E1F5
646611B95640B0DE311B498A153E5784C742BB4617D0C5D26A37DE...

                            

						

                        
Top of page
				

				

					

						
 Get-TlsCipherSet 

						
Retrieve the list of ciphers in a cipher set.

						
Retrieves the list of ciphers which are in a specified system-defined or custom cipher set.

					

                        

                        
 Syntax 

                        

						

                            


Get-TlsCipherSet -Name <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Get-TlsCipherSet -Name <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN 
<String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-Name
                                        
										The name of the cipher set.
										true
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Get-TlsCipherSet -Name Default

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.
ECDHE-RSA-AES256-SHA384
ECDHE-ECDSA-AES256-SHA384
DHE-RSA-AES256-SHA256
DHE-DSS-AES256-SHA256
DH-RSA-AES256-SHA256
DH-DSS-AES256-SHA256
ECDH-RSA-AES256-SHA384
ECDH-ECDSA-AES256-SHA384
AES256-SHA256
AES256-SHA
ECDHE-RSA-AES128-SHA256
ECDHE-ECDSA-AES128-SHA256
DHE-RSA-AES128-SHA256
DHE-DSS-AES128-SHA256
DH-RSA-AES128-SHA256
DH-DSS-AES128-SHA256
ECDH-RSA-AES128-SHA256
ECDH-ECDSA-AES128-SHA256
AES128-SHA256
AES128-SHA
DES-CBC3-SHA

                            

						

                        
Top of page
				

				

					

						
 Get-TlsHSM 

						
WARNING: This function is not available. The Hardware Security Module (HSM) feature has been removed from the LoadMaster.

						
This command will not work on LoadMaster versions 7.2.46.0 and newer. If you want to use PowerShell to configure HSM on an 
older LoadMaster 
version, use the PowerShell module corresponding to that version, for example PowerShell-7.2.45.

					

                        

                        
 Syntax 

                        

						

                            


Get-TlsHSM [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction <ActionPreference>] 
[-InformationVariable <String>] [<CommonParameters>]

Get-TlsHSM [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN <String>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Get-TlsHSM

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.
Data field...: @{engine=cavhsm; addr=10.154.11.129; user=ExampleUser; enable=0}

                            

						

                        
Top of page
				

				

					

						
 Get-TlsIntermediateCertificate 

						
Retrieve a list of intedmediate certificates currently installed on the LoadMaster.

						
Retrieve a list of intedmediate certificates currently installed on the LoadMaster.

					

                        

                        
 Syntax 

                        

						

                            


Get-TlsIntermediateCertificate [-CertName <String>] [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Get-TlsIntermediateCertificate [-CertName <String>] [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation 
<String>] [-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-CertName
                                        
										To retrieve details for a particular intermediate certificate, specify the certificate name using the CertName parameter.
										false
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-Outform
                                        
										Specify the format - either PEM or DER. DER is Base64-encoded because it is a binary format.
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Get-TlsIntermediateCertificate

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.
1       C29073E67DD34ABC117326F05B3A6EBC7610ADF0C57D6731B705E56768C36CDA211FD4C21E1FE7D6E08986B2F72973C22E4AA1B5238FE2738C3F
5A7202D67BE291C6CAEDA866...
Exam... C89E5A8F8B1FCD8F366D3DE3350B17BA44A18892DECE87B1149F26B849BA9581EFC281FBC9584F763430EF3EAC42E9F63866080766070A60C931
4F10C0A07D3CE833928F431D...

                            

						

                        
Top of page
				

				

					

						
 Get-VirtualService 

						
WARNING: This function is deprecated. Use the following command instead:
Get-AdcVirtualService

						
WARNING: This function is deprecated. Use the following command instead:
Get-AdcVirtualService

					

                        

                        
 Syntax 

                        

						

                            


Get-VirtualService [-VirtualService <String>] [-VSPort <Int32>] [-VSProtocol <String>] [-VSIndex <Int32>] [-LoadBalancer 
<String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] 
[<CommonParameters>]

Get-VirtualService [-VirtualService <String>] [-VSPort <Int32>] [-VSProtocol <String>] [-VSIndex <Int32>] [-LoadBalancer 
<String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN <String>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-VirtualService
                                        
										
										false
										false
										
									

									

										-VSPort
                                        
										
										false
										false
										
									

									

										-VSProtocol
                                        
										
										false
										false
										
									

									

										-VSIndex
                                        
										
										false
										false
										
									

									

										-LoadBalancer
                                        
										
										false
										false
										
									

									

										-LBPort
                                        
										
										false
										false
										
									

									

										-Credential
                                        
										
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										
										false
										false
										
									

									

										-SubjectCN
                                        
										
										false
										false
										
									

								
							

						
				
				

				

					

						
 Get-VSPacketFilterACL 

						
Displays the addresses on the black or white list for a Virtual Service.

						
Lists the host and network IP addresses on the black or white access control list for a specific Virtual Service. Note that 
black and white lists are only enabled when packet filtering is enabled.

					

                        

                        
 Syntax 

                        

						

                            


Get-VSPacketFilterACL [-VirtualService <String>] [-VSPort <Int32>] [-VSProtocol <String>] [-VSIndex <Int32>] -Type <String> 
[-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction <ActionPreference>] 
[-InformationVariable <String>] [<CommonParameters>]

Get-VSPacketFilterACL [-VirtualService <String>] [-VSPort <Int32>] [-VSProtocol <String>] [-VSIndex <Int32>] -Type <String> 
[-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN <String>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-VirtualService
                                        
										Specifies the Virtual Service IP address.
										false
										false
										
									

									

										-VSPort
                                        
										Specifies the Virtual Service port number.
										false
										false
										
									

									

										-VSProtocol
                                        
										Specifies the Virtual Service protocol:  "tcp" or "udp".
										false
										false
										
									

									

										-VSIndex
                                        
										The index number of the relevant Virtual Service. To retrieve the Virtual Service index, run the Get-AdcVirtualService 
command.		
										false
										false
										
									

									

										-Type
                                        
										Specify the type of list:
- black: blocked addresses
- white: allowed addresses
Note: This is case sensitive – the type value should be in lowercase.		
										true
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Get-VSPacketFilterACL -VSPort 80 -VSProtocol tcp -Type black -VirtualService 10.35.47.16

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.
10.35.47.16 80      tcp         @{addr=10.145.33.4/32; comment=}

                            

						

                        
Top of page
				

				

					

						
 Get-WafAuditFiles 

						
Returns a list of the WAF audit file names.

						
Returns a list of the WAF audit file names.

					

                        

                        
 Syntax 

                        

						

                            


Get-WafAuditFiles [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction <ActionPreference>] 
[-InformationVariable <String>] [<CommonParameters>]

Get-WafAuditFiles [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN <String>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Get-WafAuditFiles

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.
File1 : wafaudit.1

                            

						

                        
Top of page
				

				

					

						
 GetWafChangeLog 

						
WARNING: This function is deprecated. Use the following command instead:
Export-WafChangeLog

						
WARNING: This function is deprecated. Use the following command instead:
Export-WafChangeLog

					

                        

                        
 Syntax 

                        

						

                            


GetWafChangeLog [-Path <String>] [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-Force 
<SwitchParameter>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

GetWafChangeLog [-Path <String>] [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] 
[-SubjectCN <String>] [-Force <SwitchParameter>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] 
[<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-Path
                                        
										
										false
										false
										
									

									

										-LoadBalancer
                                        
										
										false
										false
										
									

									

										-LBPort
                                        
										
										false
										false
										
									

									

										-Credential
                                        
										
										false
										false
										
									

									

										-Force
                                        
										
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										
										false
										false
										
									

									

										-SubjectCN
                                        
										
										false
										false
										
									

								
							

						
				
				

				

					

						
 Get-WafRules 

						
Displays details about all installed Web Application Firewall (WAF) rules (commercial and custom).

						
Displays details about all installed Web Application Firewall (WAF) rules (commercial and custom). It also shows if the 
rules are active or not. Active rules are ones that have been assigned to one or more Virtual Services.

					

                        

                        
 Syntax 

                        

						

                            


Get-WafRules [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction <ActionPreference>] 
[-InformationVariable <String>] [<CommonParameters>]

Get-WafRules [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN <String>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Get-WafRules

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.


Inactive1  : Generic/ip_reputation
Inactive2  : Generic/known_vulns
Inactive3  : Generic/malware_detection
Inactive4  : Generic/botnet_attacks
Inactive5  : Generic/creditcard_known
Inactive6  : Generic/creditcard_track_pan
Inactive7  : ApplicationSpecific/cpanel_attacks
Inactive8  : ApplicationSpecific/drupal_attacks
Inactive9  : ApplicationSpecific/joomla_attacks
Inactive10 : ApplicationSpecific/modx_attacks
Inactive11 : ApplicationSpecific/netcat_attacks
Inactive12 : ApplicationSpecific/oscommerce_attacks
Inactive13 : ApplicationSpecific/phpbb_attacks
Inactive14 : ApplicationSpecific/sharepoint_attacks
Inactive15 : ApplicationSpecific/typo3_attacks
Inactive16 : ApplicationSpecific/vbulletin_attacks
Inactive17 : ApplicationSpecific/wordpress_attacks
Inactive18 : ApplicationSpecific/owa_attacks
Inactive19 : ApplicationSpecific/iis_attacks
Inactive20 : ApplicationGeneric/lfi_attacks
Inactive21 : ApplicationGeneric/rfi_attacks
Inactive22 : ApplicationGeneric/sqli_attacks
Inactive23 : ApplicationGeneric/xss_attacks

                            

						

                        
Top of page
				

				

					

						
 Get-WafRulesAutoUpdateConfiguration 

						
Displays the values of the Web Application Firewall (WAF) auto-update configuration.

						
Displays the values of the WAF configuration relating to the automatic updating of commercial rules.

					

                        

                        
 Syntax 

                        

						

                            


Get-WafRulesAutoUpdateConfiguration [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Get-WafRulesAutoUpdateConfiguration [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] 
[-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Get-WafRulesAutoUpdateConfiguration

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.
AutoUpdate      : 0
AutoInstall     : 1
InstallTimeHour : 4
LastUpdated     : 2017-04-05

                            

						

                        
Top of page
				

				

					

						
 GetWafSettings 

						
WARNING: This function is deprecated. Use the following command instead:
Get-WafRulesAutoUpdateConfiguration

						
WARNING: This function is deprecated. Use the following command instead:
Get-WafRulesAutoUpdateConfiguration

					

                        

                        
 Syntax 

                        

						

                            


GetWafSettings [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction <ActionPreference>] 
[-InformationVariable <String>] [<CommonParameters>]

GetWafSettings [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN <String>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-LoadBalancer
                                        
										
										false
										false
										
									

									

										-LBPort
                                        
										
										false
										false
										
									

									

										-Credential
                                        
										
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										
										false
										false
										
									

									

										-SubjectCN
                                        
										
										false
										false
										
									

								
							

						
				
				

				

					

						
 Get-WUIAuth 

						
WARNING: This function is deprecated. Use the following command instead:
Get-SecWuiAuthentication

						
WARNING: This function is deprecated. Use the following command instead:
Get-SecWuiAuthentication

					

                        

                        
 Syntax 

                        

						

                            


Get-WUIAuth [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction <ActionPreference>] 
[-InformationVariable <String>] [<CommonParameters>]

Get-WUIAuth [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN <String>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-LoadBalancer
                                        
										
										false
										false
										
									

									

										-LBPort
                                        
										
										false
										false
										
									

									

										-Credential
                                        
										
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										
										false
										false
										
									

									

										-SubjectCN
                                        
										
										false
										false
										
									

								
							

						
				
				

				

					

						
 Get-WUISetting 

						
WARNING: This function is deprecated. Use the following command instead:
Get-SecAdminWuiConfiguration

						
WARNING: This function is deprecated. Use the following command instead:
Get-SecAdminWuiConfiguration

					

                        

                        
 Syntax 

                        

						

                            


Get-WUISetting [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction <ActionPreference>] 
[-InformationVariable <String>] [<CommonParameters>]

Get-WUISetting [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN <String>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-LoadBalancer
                                        
										
										false
										false
										
									

									

										-LBPort
                                        
										
										false
										false
										
									

									

										-Credential
                                        
										
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										
										false
										false
										
									

									

										-SubjectCN
                                        
										
										false
										false
										
									

								
							

						
				
				

				

					

						
 HSMConfigure 

						
WARNING: This function is deprecated. Use the following command instead:
Set-TlsHSM

						
WARNING: This function is deprecated. Use the following command instead:
Set-TlsHSM

					

                        

                        
 Syntax 

                        

						

                            


HSMConfigure [-Sethsm <String>] [-Safeaddr <String>] [-Clpass <String>] [-Enable <Boolean>] [-Cavhsmaddr <String>] 
[-Cavhsmpasswd <String>] [-Cavhsmuser <String>] [-Cavhsmenable <Boolean>] [-LoadBalancer <String>] [-LBPort <Int32>] 
[-Credential <Object>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

HSMConfigure [-Sethsm <String>] [-Safeaddr <String>] [-Clpass <String>] [-Enable <Boolean>] [-Cavhsmaddr <String>] 
[-Cavhsmpasswd <String>] [-Cavhsmuser <String>] [-Cavhsmenable <Boolean>] [-LoadBalancer <String>] [-LBPort <Int32>] 
[-CertificateStoreLocation <String>] [-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable 
<String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-Sethsm
                                        
										
										false
										false
										
									

									

										-Safeaddr
                                        
										
										false
										false
										
									

									

										-Clpass
                                        
										
										false
										false
										
									

									

										-Enable
                                        
										
										false
										false
										
									

									

										-Cavhsmaddr
                                        
										
										false
										false
										
									

									

										-Cavhsmpasswd
                                        
										
										false
										false
										
									

									

										-Cavhsmuser
                                        
										
										false
										false
										
									

									

										-Cavhsmenable
                                        
										
										false
										false
										
									

									

										-LoadBalancer
                                        
										
										false
										false
										
									

									

										-LBPort
                                        
										
										false
										false
										
									

									

										-Credential
                                        
										
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										
										false
										false
										
									

									

										-SubjectCN
                                        
										
										false
										false
										
									

								
							

						
				
				

				

					

						
 HSMGenerateClientCert 

						
WARNING: This function is deprecated. Use the following command instead:
New-TlsHSMClientCert

						
WARNING: This function is deprecated. Use the following command instead:
New-TlsHSMClientCert

					

                        

                        
 Syntax 

                        

						

                            


HSMGenerateClientCert -Path <String> -Clcertname <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] 
[-Force <SwitchParameter>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

HSMGenerateClientCert -Path <String> -Clcertname <String> [-LoadBalancer <String>] [-LBPort <Int32>] 
[-CertificateStoreLocation <String>] [-SubjectCN <String>] [-Force <SwitchParameter>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-Path
                                        
										
										true
										false
										
									

									

										-Clcertname
                                        
										
										true
										false
										
									

									

										-LoadBalancer
                                        
										
										false
										false
										
									

									

										-LBPort
                                        
										
										false
										false
										
									

									

										-Credential
                                        
										
										false
										false
										
									

									

										-Force
                                        
										
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										
										false
										false
										
									

									

										-SubjectCN
                                        
										
										false
										false
										
									

								
							

						
				
				

				

					

						
 HSMShow 

						
WARNING: This function is deprecated. Use the following command instead:
Get-TlsHSM

						
WARNING: This function is deprecated. Use the following command instead:
Get-TlsHSM

					

                        

                        
 Syntax 

                        

						

                            


HSMShow [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction <ActionPreference>] 
[-InformationVariable <String>] [<CommonParameters>]

HSMShow [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN <String>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-LoadBalancer
                                        
										
										false
										false
										
									

									

										-LBPort
                                        
										
										false
										false
										
									

									

										-Credential
                                        
										
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										
										false
										false
										
									

									

										-SubjectCN
                                        
										
										false
										false
										
									

								
							

						
				
				

				

					

						
 HSMUploadCACert 

						
WARNING: This function is deprecated. Use the following command instead:
Import-TlsHSMCACert

						
WARNING: This function is deprecated. Use the following command instead:
Import-TlsHSMCACert

					

                        

                        
 Syntax 

                        

						

                            


HSMUploadCACert -Path <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

HSMUploadCACert -Path <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN 
<String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-Path
                                        
										
										true
										false
										
									

									

										-LoadBalancer
                                        
										
										false
										false
										
									

									

										-LBPort
                                        
										
										false
										false
										
									

									

										-Credential
                                        
										
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										
										false
										false
										
									

									

										-SubjectCN
                                        
										
										false
										false
										
									

								
							

						
				
				

				

					

						
 Import-GeoDNSSECKeySigningKey 

						
Import the GEO DNSSEC Key Signing Keys (KSKs).

						
This command uploads both KSK files at the same time.

					

                        

                        
 Syntax 

                        

						

                            


Import-GeoDNSSECKeySigningKey -privateKeyFile <String> -publicKeyFile <String> [-LoadBalancer <String>] [-LBPort <Int32>] 
[-Credential <Object>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Import-GeoDNSSECKeySigningKey -privateKeyFile <String> -publicKeyFile <String> [-LoadBalancer <String>] [-LBPort <Int32>] 
[-CertificateStoreLocation <String>] [-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable 
<String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-privateKeyFile
                                        
										The path to the private key file to upload.
										true
										false
										
									

									

										-publicKeyFile
                                        
										The path to the public key file to upload.
										true
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Import-GeoDNSSECKeySigningKey -privateKeyFile .\key.private -publicKeyFile .\public.key

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.

                            

						

                        
Top of page
				

				

					

						
 Import-TlsHSMCACert 

						
WARNING: This function is not available. The Hardware Security Module (HSM) feature has been removed from the LoadMaster.

						
This command will not work even if you are using a version of LoadMaster older than 7.2.46 that has the HSM feature. If you 
want to use PowerShell to configure HSM on an older LoadMaster version, use the corresponding old PowerShell module, for 
example Powershell-7.2.45.

					

                        

                        
 Syntax 

                        

						

                            


Import-TlsHSMCACert -Path <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Import-TlsHSMCACert -Path <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] 
[-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-Path
                                        
										The path to the certificate file followed by a backslash and the certificate file name followed by the file extension 
(.pem).		
										true
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Import-TlsHSMCACert –Path c:\CertificateFileName.pem

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.

                            

						

                        
Top of page
				

				

					

						
 Initialize-LmConnectionParameters 

						
Specify the connection parameters to use for the session.

						
To run PowerShell API commands, you need to establish authentication with the LoadMaster. There are two ways to establish 
authentication:
• Using credentials; a LoadMaster username (Credential) and password
• Using certificate-based authentication
Whichever option you use, you can either specify the parameters when running individual commands, or using the 
Initialize-LmConnectionParameters command.
You can also globally set the Kemp LoadMaster IP address that you are directing the commands to by using the 
Initialize-LmConnectionParameters command, for example:
Initialize-LmConnectionParameters -Address 10.11.0.60 -LBPort 443 -Credential bal
You can either enter a username for the LoadMaster or provide a PSCredential object. When you enter a username, a prompt 
appears asking for the password. You can override the globally-provided LoadBalancer address and username on each 
individual command by using the LoadBalancer or Credential parameter within the command.
Similarly, you can specify the details to use certificate-based authentication using the Initialize-LmConnectionParameters 
command. For further information on the various steps involved to configure certificate-based authentication, refer to the 
PowerShell Interface Description document.

					

                        

                        
 Syntax 

                        

						

                            


Initialize-LmConnectionParameters -Address <String> [-LBPort <Int32>] [-Credential <Object>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Initialize-LmConnectionParameters -Address <String> [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN 
<String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-Address
                                        
										Specify the address of the LoadMaster to run commands on.
Use this command to specify the LoadMaster address to be used for this session. If this is done, there is no need to fill 
out the LoadBalancer field when running a command, unless you want to overwrite it.		
										true
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Use this command to specify the LoadMaster port to be used for the session. If this is done, there is no need to fill out 
the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Use this command to specify the username for the session. If this is done, there is no need to fill out the Credential 
field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Use this command to specify the CertificateStoreLocation for the session. If this is done, there is no need to fill out the 
CertificateStoreLocation field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Use this command to specify the SubjectCN for the session. If this is done, there is no need to fill out the SubjectCN 
field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Initialize-LmConnectionParameters -Address 10.154.11.180 -Credential bal

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.

                            

						

                        
Top of page
				

				

					

						
 Initialize-LoadBalancer 

						
WARNING: This function is deprecated. Use the following command instead:
Initialize-LmConnectionParameters

						
WARNING: This function is deprecated. Use the following command instead:
Initialize-LmConnectionParameters

					

                        

                        
 Syntax 

                        

						

                            


Initialize-LoadBalancer -Address <String> [-LBPort <Int32>] [-Credential <Object>] [-InformationAction <ActionPreference>] 
[-InformationVariable <String>] [<CommonParameters>]

Initialize-LoadBalancer -Address <String> [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN <String>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-Address
                                        
										
										true
										false
										
									

									

										-LBPort
                                        
										
										false
										false
										
									

									

										-Credential
                                        
										
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										
										false
										false
										
									

									

										-SubjectCN
                                        
										
										false
										false
										
									

								
							

						
				
				

				

					

						
 Install-GeoIPBlacklistDatabase 

						
Install any downloaded updates now.

						
Run this command to install any updates to the GEO IP blacklist database which have been downloaded.

					

                        

                        
 Syntax 

                        

						

                            


Install-GeoIPBlacklistDatabase [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Install-GeoIPBlacklistDatabase [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN 
<String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Install-GeoIPBlacklistDatabase

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.

                            

						

                        
Top of page
				

				

					

						
 Install-LmAddon 

						
Allows you to upload an add-on pack.

						
Allows you to upload an add-on pack.

					

                        

                        
 Syntax 

                        

						

                            


Install-LmAddon -Path <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Install-LmAddon -Path <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN 
<String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-Path
                                        
										The path to the add-on file followed by a backslash and then the filename, for example 
C:\Users\ExampleUser\Desktop\Akami.7.1-22b.20141204-1618		
										true
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Install-LmAddon -Path C:\Temp\SMART.7.2.39.0.15038.DEV.20170424-0907

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.
Data field...: @{Package=Addon Package \'SMART\' Correctly installed - Please reboot to activate it.}

                            

						

                        
Top of page
				

				

					

						
 Install-LmPatch 

						
Allows you to update the LoadMaster with a patch to the firmware.

						
Allows you to update the LoadMaster with a patch to the firmware. You will be asked to restart the LoadMaster for the 
command to complete.

					

                        

                        
 Syntax 

                        

						

                            


Install-LmPatch -Path <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Install-LmPatch -Path <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN 
<String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-Path
                                        
										The local path to the LoadMaster patch file that should be uploaded. This parameter is required.
										true
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Install-LmPatch -Path c:\SoftwareUpdate\7.0-10.20130507-1024-32bit

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.
Data field...: @{PatchData=Patch successfully installed. Please reboot the LM to apply the new software.}

                            

						

                        
Top of page
				

				

					

						
 Install-Patch 

						
WARNING: This function is deprecated. Use the following command instead:
Install-LmPatch

						
WARNING: This function is deprecated. Use the following command instead:
Install-LmPatch

					

                        

                        
 Syntax 

                        

						

                            


Install-Patch -Path <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Install-Patch -Path <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN 
<String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-Path
                                        
										
										true
										false
										
									

									

										-LoadBalancer
                                        
										
										false
										false
										
									

									

										-LBPort
                                        
										
										false
										false
										
									

									

										-Credential
                                        
										
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										
										false
										false
										
									

									

										-SubjectCN
                                        
										
										false
										false
										
									

								
							

						
				
				

				

					

						
 Install-SAMLIdpMetafile 

						
Upload an Identity Provider (IdP) metadata file.

						
This simplifies the configuration of the IdP attributes, including the IdP Entity ID, IdP SSO URL and IdP Logoff URL. The 
metadata file can be downloaded from the IdP.

					

                        

                        
 Syntax 

                        

						

                            


Install-SAMLIdpMetafile -Domain <String> -Path <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Install-SAMLIdpMetafile -Domain <String> -Path <String> [-LoadBalancer <String>] [-LBPort <Int32>] 
[-CertificateStoreLocation <String>] [-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable 
<String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-Domain
                                        
										The name of the SSO domain to upload the mdetadata file to.
										true
										false
										
									

									

										-Path
                                        
										The path to the metadata file to be uploaded, followed by the filename and extension, for example, 
C:\ExampleFolder\ExampleIdPMetaDataFile.xml.		
										true
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Install-SAMLIdpMetafile -Domain example2.com -Path C:\Temp\federationmetadata.xml.zip

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.
Data field...: @{Domain=}
Param........: @{Id=9; Name=EXAMPLE2.COM; server=10.154.45.22; auth_type=SAML; idp_entity_id=; idp_sso_url=; 
idp_logoff_url=; idp_cert=; sp_entity_id=; 
sp_cert=UseSelfSigned; sess_tout_type=idle time; sess_tout_idle_pub=900; sess_tout_duration_pub=1800}


Id                     : 9
Name                   : EXAMPLE2.COM
server                 : 10.154.45.22
auth_type              : SAML
idp_entity_id          : 
idp_sso_url            : 
idp_logoff_url         : 
idp_cert               : 
sp_entity_id           : 
sp_cert                : UseSelfSigned
sess_tout_type         : idle time
sess_tout_idle_pub     : 900
sess_tout_duration_pub : 1800

                            

						

                        
Top of page
				

				

					

						
 Install-SSORSAConfigurationFile 

						
Allows you to upload the RSA configuration file.

						
If using RSA-SECURID as the authtype, a configuration file needs to be uploaded to the LoadMaster in order for the 
authentication to work.
The Install-SSORSAConfigurationFile command can be used to upload these files.

					

                        

                        
 Syntax 

                        

						

                            


Install-SSORSAConfigurationFile -Path <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Install-SSORSAConfigurationFile -Path <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation 
<String>] [-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-Path
                                        
										The path to the RSA configuration file, followed by a backslash and then the filename.extension.
										true
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Install-SSORSAConfigurationFile -Path C:\examplefolder.AM_Config.zip

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed. Authentication Manager Config successfully 
loaded.; Data=}
Return Code..: 200
Response.....: Command successfully executed. Authentication Manager Config successfully loaded.

                            

						

                        
Top of page
				

				

					

						
 Install-SSORSANodeSecretAndPassword 

						
Allows you to upload the node secret file.

						
If using RSA-SECURID as the authtype, a node secret file needs to be uploaded to the LoadMaster in order for the 
authentication to work.
To upload the node secret file, run the Install-SSORSANodeSecretAndPassword command.

					

                        

                        
 Syntax 

                        

						

                            


Install-SSORSANodeSecretAndPassword -Password <String> -Path <String> [-LoadBalancer <String>] [-LBPort <Int32>] 
[-Credential <Object>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Install-SSORSANodeSecretAndPassword -Password <String> -Path <String> [-LoadBalancer <String>] [-LBPort <Int32>] 
[-CertificateStoreLocation <String>] [-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable 
<String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-Password
                                        
										The password to decrypt the node secret.
										true
										false
										
									

									

										-Path
                                        
										The path to the node secret file, followed by a backslash and then the filename.extension.
										true
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Install-SSORSANodeSecretAndPassword -Password examplepassword -Path C:\examplefolder\LM_NodeSecret.zip

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed. Node Secret successfully loaded.; Data=}
Return Code..: 200
Response.....: Command successfully executed. Node Secret successfully loaded.

                            

						

                        
Top of page
				

				

					

						
 Install-Template 

						
Allows you to upload a template to the LoadMaster.

						
Allows you to upload a template to the LoadMaster.

					

                        

                        
 Syntax 

                        

						

                            


Install-Template -Path <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Install-Template -Path <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN 
<String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-Path
                                        
										The path to the template location followed by a backslash and the filename of the template.tmpl.
										true
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Install-Template –Path “C:\ Exchange2013Additional v1.6.4.tmpl”

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.

TemplateData                             
------------                             
Installed 1 new Kemp certified templates.

                            

						

                        
Top of page
				

				

					

						
 Install-WafRulesDatabase 

						
Manually install the latest commercial Web Application Firewall (WAF) rules.

						
Manually install the (previously downloaded) latest commercial WAF rules.

					

                        

                        
 Syntax 

                        

						

                            


Install-WafRulesDatabase [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Install-WafRulesDatabase [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN 
<String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Install-WafRulesDatabase

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.

                            

						

                        
Top of page
				

				

					

						
 IsGEOEnabled 

						
WARNING: This function is deprecated. Use the following command instead:
Test-LmGeoEnabled

						
WARNING: This function is deprecated. Use the following command instead:
Test-LmGeoEnabled

					

                        

                        
 Syntax 

                        

						

                            


IsGEOEnabled [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction <ActionPreference>] 
[-InformationVariable <String>] [<CommonParameters>]

IsGEOEnabled [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN <String>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-LoadBalancer
                                        
										
										false
										false
										
									

									

										-LBPort
                                        
										
										false
										false
										
									

									

										-Credential
                                        
										
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										
										false
										false
										
									

									

										-SubjectCN
                                        
										
										false
										false
										
									

								
							

						
				
				

				

					

						
 Join-Cluster 

						
Initiates a node joining a cluster.

						
This makes the node LoadMaster available to be added. To finish adding the node, please run the New-ClusterNode command on 
the shared IP address immediately after running the Join-Cluster command in a different console window.

					

                        

                        
 Syntax 

                        

						

                            


Join-Cluster [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction <ActionPreference>] 
[-InformationVariable <String>] [<CommonParameters>]

Join-Cluster [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN <String>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-LoadBalancer
                                        
										Specify the shared address of the cluster to run the command on.
Note: The address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, 
there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Join-Cluster

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.

                            

						

                        
Top of page
				

				

					

						
 ListAddons 

						
WARNING: This function is deprecated. Use the following command instead:
Get-LmAddOn

						
WARNING: This function is deprecated. Use the following command instead:
Get-LmAddOn

					

                        

                        
 Syntax 

                        

						

                            


ListAddons [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction <ActionPreference>] 
[-InformationVariable <String>] [<CommonParameters>]

ListAddons [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN <String>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-LoadBalancer
                                        
										
										false
										false
										
									

									

										-LBPort
                                        
										
										false
										false
										
									

									

										-Credential
                                        
										
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										
										false
										false
										
									

									

										-SubjectCN
                                        
										
										false
										false
										
									

								
							

						
				
				

				

					

						
 ListCert 

						
WARNING: This function is deprecated. Use the following command instead:
Get-TlsCertificate

						
WARNING: This function is deprecated. Use the following command instead:
Get-TlsCertificate

					

                        

                        
 Syntax 

                        

						

                            


ListCert [-CertName <String>] [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

ListCert [-CertName <String>] [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN 
<String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-CertName
                                        
										
										false
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										
										false
										false
										
									

									

										-SubjectCN
                                        
										
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

ListCert

							    
Example Command:
cert              
----              
ExampleCertificate

                            

						

                        
Top of page
				

				

					

						
 ListCustomLocation 

						
WARNING: This function is deprecated. Use the following command instead:
Get-GeoCustomLocation

						
WARNING: This function is deprecated. Use the following command instead:
Get-GeoCustomLocation

					

                        

                        
 Syntax 

                        

						

                            


ListCustomLocation [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

ListCustomLocation [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN <String>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-LoadBalancer
                                        
										
										false
										false
										
									

									

										-LBPort
                                        
										
										false
										false
										
									

									

										-Credential
                                        
										
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										
										false
										false
										
									

									

										-SubjectCN
                                        
										
										false
										false
										
									

								
							

						
				
				

				

					

						
 ListFQDNs 

						
WARNING: This function is deprecated. Use the following command instead:
Get-GeoFQDN

						
WARNING: This function is deprecated. Use the following command instead:
Get-GeoFQDN

					

                        

                        
 Syntax 

                        

						

                            


ListFQDNs [-FQDN <String>] [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

ListFQDNs [-FQDN <String>] [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN 
<String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-FQDN
                                        
										
										false
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										
										false
										false
										
									

									

										-SubjectCN
                                        
										
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

ListFQDNs

							    
Example Output:
Mapping                  : 0
IsolatedIPs              : Y
SiteRecoveryMode         : auto
FailTime                 : 300
Failover                 : 0
SelectionCriteria        : rr
FullyQualifiedDomainName : www.example3.com.

Mapping                  : 0
IsolatedIPs              : Y
SiteRecoveryMode         : auto
FailTime                 : 0
Failover                 : 0
SelectionCriteria        : rr
FullyQualifiedDomainName : 10.154.60.65.

Mapping                  : 0
IsolatedIPs              : Y
SiteRecoveryMode         : auto
FailTime                 : 0
Failover                 : 0
SelectionCriteria        : rr
FullyQualifiedDomainName : example4.com.

                            

						

                        
Top of page
				

				

					

						
 ListIfconfig 

						
WARNING: This function is deprecated. Use the following command instead:
Get-LmNetworkInterface

						
WARNING: This function is deprecated. Use the following command instead:
Get-LmNetworkInterface

					

                        

                        
 Syntax 

                        

						

                            


ListIfconfig [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction <ActionPreference>] 
[-InformationVariable <String>] [<CommonParameters>]

ListIfconfig [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN <String>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

ListIfconfig

							    
Example Output:
Network                                                                                                                     
                                 
-------                                                                                                                     
                                 
0eth010002718138020260710800up1462801058,1eth11000171006002076800up1462801058,2bnd21000206736002035771400up1462801058,3bnd31
000206748402135745000up1462801058

                            

						

                        
Top of page
				

				

					

						
 ListIPs 

						
WARNING: This function is deprecated. Use the following command instead:
Get-GeoIpRange

						
WARNING: This function is deprecated. Use the following command instead:
Get-GeoIpRange

					

                        

                        
 Syntax 

                        

						

                            


ListIPs [-IP <String>] [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

ListIPs [-IP <String>] [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN 
<String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-IP
                                        
										
										false
										false
										
									

									

										-LoadBalancer
                                        
										The IP address of the Kemp LoadMaster that you are directing the command to. This can be set globally by using the 
Initialize-LoadBalancer command, but can be overridden on each individual command by using this parameter.		
										false
										false
										
									

									

										-LBPort
                                        
										
										false
										false
										
									

									

										-Credential
                                        
										Specifies a user account that has permission to administer the load balancer. You can either enter a username for the load 
balancer or provide a PSCredential object, such as an object that is returned by the Get-Credential cmdlet. When you type a 
username, you are prompted for a password.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										
										false
										false
										
									

									

										-SubjectCN
                                        
										
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

ListIPs

							    
Example Output:
Longitude      : 1234
Ip             : 10.154.11.29
Used           : Y
IsCustom       : Y
Mask           : 32
Index          : 1
CustomLocation : ExampleLocation2
IPAddress      : 10.154.11.29
Latitude       : 1234

Ip        : 10.154.11.30
Used      : Y
IsCustom  : N
Mask      : 32
Index     : 2
IPAddress : 10.154.11.30
country   : IE,Ireland

                            

						

                        
Top of page
				

				

					

						
 ListMiscParameters 

						
WARNING: This function is deprecated. Use the following command instead:
Get-GeoMiscParameter

						
WARNING: This function is deprecated. Use the following command instead:
Get-GeoMiscParameter

					

                        

                        
 Syntax 

                        

						

                            


ListMiscParameters [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

ListMiscParameters [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN <String>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-LoadBalancer
                                        
										
										false
										false
										
									

									

										-LBPort
                                        
										
										false
										false
										
									

									

										-Credential
                                        
										
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										
										false
										false
										
									

									

										-SubjectCN
                                        
										
										false
										false
										
									

								
							

						
				
				

				

					

						
 ListTemplates 

						
WARNING: This function is deprecated. Use the following command instead:
Get-Template

						
WARNING: This function is deprecated. Use the following command instead:
Get-Template

					

                        

                        
 Syntax 

                        

						

                            


ListTemplates [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction <ActionPreference>] 
[-InformationVariable <String>] [<CommonParameters>]

ListTemplates [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN <String>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-LoadBalancer
                                        
										
										false
										false
										
									

									

										-LBPort
                                        
										
										false
										false
										
									

									

										-Credential
                                        
										
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										
										false
										false
										
									

									

										-SubjectCN
                                        
										
										false
										false
										
									

								
							

						
				
				

				

					

						
 ListVpns 

						
WARNING: This function is deprecated. Use the following command instead:
Get-LmVpnConnection

						
WARNING: This function is deprecated. Use the following command instead:
Get-LmVpnConnection

					

                        

                        
 Syntax 

                        

						

                            


ListVpns [-Name <String>] [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

ListVpns [-Name <String>] [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN 
<String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-Name
                                        
										
										false
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										
										false
										false
										
									

									

										-SubjectCN
                                        
										
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

ListVpns

							    
Example Output:
pfs          : disabled
localIP      : 10.154.11.10
remoteSubnet : 10.154.11.30/32
remoteIP     : 10.154.11.20
name         : Example
remoteID     : 10.154.11.20
localID      : 10.154.11.10
status       : Down
localSubnet  : 10.154.11.10/32
key          :

                            

						

                        
Top of page
				

				

					

						
 ListWafAuditFiles 

						
WARNING: This function is deprecated. Use the following command instead:
Get-WafAuditFiles

						
WARNING: This function is deprecated. Use the following command instead:
Get-WafAuditFiles

					

                        

                        
 Syntax 

                        

						

                            


ListWafAuditFiles [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction <ActionPreference>] 
[-InformationVariable <String>] [<CommonParameters>]

ListWafAuditFiles [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN <String>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-LoadBalancer
                                        
										
										false
										false
										
									

									

										-LBPort
                                        
										
										false
										false
										
									

									

										-Credential
                                        
										
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										
										false
										false
										
									

									

										-SubjectCN
                                        
										
										false
										false
										
									

								
							

						
				
				

				

					

						
 ListWafRules 

						
WARNING: This function is deprecated. Use the following command instead:
Get-WafRules

						
WARNING: This function is deprecated. Use the following command instead:
Get-WafRules

					

                        

                        
 Syntax 

                        

						

                            


ListWafRules [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction <ActionPreference>] 
[-InformationVariable <String>] [<CommonParameters>]

ListWafRules [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN <String>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-LoadBalancer
                                        
										
										false
										false
										
									

									

										-LBPort
                                        
										
										false
										false
										
									

									

										-Credential
                                        
										
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										
										false
										false
										
									

									

										-SubjectCN
                                        
										
										false
										false
										
									

								
							

						
				
				

				

					

						
 LocationDataUpdate 

						
WARNING: This function is deprecated. Use the following command instead:
Update-GeoDatabase

						
WARNING: This function is deprecated. Use the following command instead:
Update-GeoDatabase

					

                        

                        
 Syntax 

                        

						

                            


LocationDataUpdate -Path <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

LocationDataUpdate -Path <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] 
[-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-Path
                                        
										
										true
										false
										
									

									

										-LoadBalancer
                                        
										
										false
										false
										
									

									

										-LBPort
                                        
										
										false
										false
										
									

									

										-Credential
                                        
										
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										
										false
										false
										
									

									

										-SubjectCN
                                        
										
										false
										false
										
									

								
							

						
				
				

				

					

						
 ManInstallWafRules 

						
WARNING: This function is deprecated. Use the following command instead:
Install-WafRulesDatabase

						
WARNING: This function is deprecated. Use the following command instead:
Install-WafRulesDatabase

					

                        

                        
 Syntax 

                        

						

                            


ManInstallWafRules [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

ManInstallWafRules [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN <String>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										
										false
										false
										
									

									

										-SubjectCN
                                        
										
										false
										false
										
									

								
							

						
				
						

                            

                                
 Note 

                            

							
An error message will be displayed if any problems occur while installing the rules.

						

                        

                            
 Examples 

                        

						

                            

							    Example

ManInstallWafRules

							    
Example Output:
ok

                            

						

                        
Top of page
				

				

					

						
 ModifyCipherset 

						
WARNING: This function is deprecated. Use the following command instead:
Set-TlsCipherSet

						
WARNING: This function is deprecated. Use the following command instead:
Set-TlsCipherSet

					

                        

                        
 Syntax 

                        

						

                            


ModifyCipherset -Name <String> -Value <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

ModifyCipherset -Name <String> -Value <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation 
<String>] [-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-Name
                                        
										
										true
										false
										
									

									

										-Value
                                        
										
										true
										false
										
									

									

										-LoadBalancer
                                        
										
										false
										false
										
									

									

										-LBPort
                                        
										
										false
										false
										
									

									

										-Credential
                                        
										
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										
										false
										false
										
									

									

										-SubjectCN
                                        
										
										false
										false
										
									

								
							

						
				
				

				

					

						
 ModifyCluster 

						
WARNING: This function is deprecated. Use the following command instead:
Set-GeoCluster

						
WARNING: This function is deprecated. Use the following command instead:
Set-GeoCluster

					

                        

                        
 Syntax 

                        

						

                            


ModifyCluster -ClusterIp <String> [-ClusterName <String>] [-Type <String>] [-Checker <String>] [-CheckerPort <Int32>] 
[-Enable <String>] [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

ModifyCluster -ClusterIp <String> [-ClusterName <String>] [-Type <String>] [-Checker <String>] [-CheckerPort <Int32>] 
[-Enable <String>] [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN <String>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-ClusterIp
                                        
										
										true
										false
										
									

									

										-ClusterName
                                        
										
										false
										false
										
									

									

										-Type
                                        
										
										false
										false
										
									

									

										-Checker
                                        
										
										false
										false
										
									

									

										-CheckerPort
                                        
										
										false
										false
										
									

									

										-Enable
                                        
										
										false
										false
										
									

									

										-LoadBalancer
                                        
										
										false
										false
										
									

									

										-LBPort
                                        
										
										false
										false
										
									

									

										-Credential
                                        
										
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										
										false
										false
										
									

									

										-SubjectCN
                                        
										
										false
										false
										
									

								
							

						
				
				

				

					

						
 ModifyFQDN 

						
WARNING: This function is deprecated. Use the following command instead:
Set-GeoFQDN

						
WARNING: This function is deprecated. Use the following command instead:
Set-GeoFQDN

					

                        

                        
 Syntax 

                        

						

                            


ModifyFQDN -FQDN <String> [-SelectionCriteria <String>] [-SiteFailureDelay <Int32>] [-SiteRecoveryMode <String>] 
[-PublicRequest <String>] [-PrivateRequest <String>] [-Failover <String>] [-LocalSettings <Boolean>] [-localttl <Int32>] 
[-localsticky <Int32>] [-UnanimousChecks <Boolean>] [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

ModifyFQDN -FQDN <String> [-SelectionCriteria <String>] [-SiteFailureDelay <Int32>] [-SiteRecoveryMode <String>] 
[-PublicRequest <String>] [-PrivateRequest <String>] [-Failover <String>] [-LocalSettings <Boolean>] [-localttl <Int32>] 
[-localsticky <Int32>] [-UnanimousChecks <Boolean>] [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation 
<String>] [-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-FQDN
                                        
										
										true
										false
										
									

									

										-SelectionCriteria
                                        
										
										false
										false
										
									

									

										-SiteFailureDelay
                                        
										
										false
										false
										
									

									

										-SiteRecoveryMode
                                        
										
										false
										false
										
									

									

										-PublicRequest
                                        
										
										false
										false
										
									

									

										-PrivateRequest
                                        
										
										false
										false
										
									

									

										-Failover
                                        
										
										false
										false
										
									

									

										-LocalSettings
                                        
										
										false
										false
										
									

									

										-localttl
                                        
										
										false
										false
										
									

									

										-localsticky
                                        
										
										false
										false
										
									

									

										-UnanimousChecks
                                        
										
										false
										false
										
									

									

										-LoadBalancer
                                        
										
										false
										false
										
									

									

										-LBPort
                                        
										
										false
										false
										
									

									

										-Credential
                                        
										
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										
										false
										false
										
									

									

										-SubjectCN
                                        
										
										false
										false
										
									

								
							

						
				
				

				

					

						
 ModifyIPLocation 

						
WARNING: This function is deprecated. Use the following command instead:
Set-GeoIPRangeCoordinates

						
WARNING: This function is deprecated. Use the following command instead:
Set-GeoIPRangeCoordinates

					

                        

                        
 Syntax 

                        

						

                            


ModifyIPLocation -IP <String> -Lat <Int32> -Long <Int32> [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

ModifyIPLocation -IP <String> -Lat <Int32> -Long <Int32> [-LoadBalancer <String>] [-LBPort <Int32>] 
[-CertificateStoreLocation <String>] [-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable 
<String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-IP
                                        
										
										true
										false
										
									

									

										-Lat
                                        
										
										true
										false
										
									

									

										-Long
                                        
										
										true
										false
										
									

									

										-LoadBalancer
                                        
										
										false
										false
										
									

									

										-LBPort
                                        
										
										false
										false
										
									

									

										-Credential
                                        
										
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										
										false
										false
										
									

									

										-SubjectCN
                                        
										
										false
										false
										
									

								
							

						
				
				

				

					

						
 ModifyMap 

						
WARNING: This function is deprecated. Use the following command instead:
Set-GeoFQDNSiteAddress

						
WARNING: This function is deprecated. Use the following command instead:
Set-GeoFQDNSiteAddress

					

                        

                        
 Syntax 

                        

						

                            


ModifyMap -FQDN <String> -SiteAddress <String> [-Checker <String>] [-Weight <Int32>] [-Enable <String>] [-Cluster <String>] 
[-Mapaddress <String>] [-Mapport <String>] [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

ModifyMap -FQDN <String> -SiteAddress <String> [-Checker <String>] [-Weight <Int32>] [-Enable <String>] [-Cluster <String>] 
[-Mapaddress <String>] [-Mapport <String>] [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] 
[-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-FQDN
                                        
										
										true
										false
										
									

									

										-SiteAddress
                                        
										
										true
										false
										
									

									

										-Checker
                                        
										
										false
										false
										
									

									

										-Weight
                                        
										
										false
										false
										
									

									

										-Enable
                                        
										
										false
										false
										
									

									

										-Cluster
                                        
										
										false
										false
										
									

									

										-Mapaddress
                                        
										
										false
										false
										
									

									

										-Mapport
                                        
										
										false
										false
										
									

									

										-LoadBalancer
                                        
										
										false
										false
										
									

									

										-LBPort
                                        
										
										false
										false
										
									

									

										-Credential
                                        
										
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										
										false
										false
										
									

									

										-SubjectCN
                                        
										
										false
										false
										
									

								
							

						
				
				

				

					

						
 ModifyMiscParameters 

						
WARNING: This function is deprecated. Use the following command instead:
Set-GeoMiscParameter

						
WARNING: This function is deprecated. Use the following command instead:
Set-GeoMiscParameter

					

                        

                        
 Syntax 

                        

						

                            


ModifyMiscParameters [-SourceOfAuthority <String>] [-NameSrv <String>] [-SOAEmail <String>] [-TTL <String>] [-Persist 
<String>] [-CheckInterval <String>] [-ConnTimeout <String>] [-RetryAttempts <String>] [-Zone <String>] [-LoadBalancer 
<String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] 
[<CommonParameters>]

ModifyMiscParameters [-SourceOfAuthority <String>] [-NameSrv <String>] [-SOAEmail <String>] [-TTL <String>] [-Persist 
<String>] [-CheckInterval <String>] [-ConnTimeout <String>] [-RetryAttempts <String>] [-Zone <String>] [-LoadBalancer 
<String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN <String>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-SourceOfAuthority
                                        
										
										false
										false
										
									

									

										-NameSrv
                                        
										
										false
										false
										
									

									

										-SOAEmail
                                        
										
										false
										false
										
									

									

										-TTL
                                        
										
										false
										false
										
									

									

										-Persist
                                        
										
										false
										false
										
									

									

										-CheckInterval
                                        
										
										false
										false
										
									

									

										-ConnTimeout
                                        
										
										false
										false
										
									

									

										-RetryAttempts
                                        
										
										false
										false
										
									

									

										-Zone
                                        
										
										false
										false
										
									

									

										-LoadBalancer
                                        
										
										false
										false
										
									

									

										-LBPort
                                        
										
										false
										false
										
									

									

										-Credential
                                        
										
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										
										false
										false
										
									

									

										-SubjectCN
                                        
										
										false
										false
										
									

								
							

						
				
				

				

					

						
 ModifySDNController 

						
WARNING: This function is deprecated. Use the following command instead:
Set-SdnController

						
WARNING: This function is deprecated. Use the following command instead:
Set-SdnController

					

                        

                        
 Syntax 

                        

						

                            


ModifySDNController -Cid <Int32> [-Clid <Int32>] [-IPV4 <String>] [-Port <Int32>] [-Https <Boolean>] [-User <String>] 
[-Password <String>] [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

ModifySDNController -Cid <Int32> [-Clid <Int32>] [-IPV4 <String>] [-Port <Int32>] [-Https <Boolean>] [-User <String>] 
[-Password <String>] [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN <String>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-Cid
                                        
										
										true
										false
										
									

									

										-Clid
                                        
										
										false
										false
										
									

									

										-IPV4
                                        
										
										false
										false
										
									

									

										-Port
                                        
										
										false
										false
										
									

									

										-Https
                                        
										
										false
										false
										
									

									

										-User
                                        
										
										false
										false
										
									

									

										-Password
                                        
										
										false
										false
										
									

									

										-LoadBalancer
                                        
										
										false
										false
										
									

									

										-LBPort
                                        
										
										false
										false
										
									

									

										-Credential
                                        
										
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										
										false
										false
										
									

									

										-SubjectCN
                                        
										
										false
										false
										
									

								
							

						
				
				

				

					

						
 New-AdcContentRule 

						
Allows you to add a new rule to the LoadMaster.

						
Allows you to add a new Content Rule rule.

					

                        

                        
 Syntax 

                        

						

                            


New-AdcContentRule -RuleName <String> [-MatchType <String>] [-IncHost <Boolean>] [-NoCase <Boolean>] [-Negate <Boolean>] 
[-IncQuery <Boolean>] [-Header <String>] [-Pattern <String>] [-Replacement <String>] [-Type <Int32>] [-MustFail <Int32>] 
[-OnlyOnFlag <Int32>] [-SetFlagOnMatch <Int32>] [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

New-AdcContentRule -RuleName <String> [-MatchType <String>] [-IncHost <Boolean>] [-NoCase <Boolean>] [-Negate <Boolean>] 
[-IncQuery <Boolean>] [-Header <String>] [-Pattern <String>] [-Replacement <String>] [-Type <Int32>] [-MustFail <Int32>] 
[-OnlyOnFlag <Int32>] [-SetFlagOnMatch <Int32>] [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation 
<String>] [-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-RuleName
                                        
										The desired name for the new content rule.
										true
										false
										
									

									

										-MatchType
                                        
										Specifies whether the rule matches on a regular expression (regex), prefix, or postfix. This parameter defaults to regex, 
but will also accept prefix or postfix.		
										false
										false
										
									

									

										-IncHost
                                        
										Specifies whether to include the host in the URL. This is disabled by default.
										false
										false
										
									

									

										-NoCase
                                        
										Specifies whether to ignore case/capitalization. This is disabled by default.
										false
										false
										
									

									

										-Negate
                                        
										Specifies whether to invert the case of the match. This is disabled by default.
										false
										false
										
									

									

										-IncQuery
                                        
										Specifies whether to include the query string in the match. This is disabled by default.
										false
										false
										
									

									

										-Header
                                        
										Specifies the header that a match should be performed on. Set this to body to match on the body of a request.
										false
										false
										
									

									

										-Pattern
                                        
										Specifies the pattern to search for.
										false
										false
										
									

									

										-Replacement
                                        
										Specifies the replacement string for the pattern. You can enter a maximum of 255 characters in this parameter.
										false
										false
										
									

									

										-Type
                                        
										The type of content rule:
0 - Content Matching
1 - Add Header
2 - Delete Header
3 - Replace Header
4 - Modify URL
5 - Replace String in Response Body
When creating a Rule - if the "type" is not specified, it will default to zero, that is, a Content Matching rule. The other 
parameters available for the New-AdcContentRule command depend on the "type" of content rule being added.		
										false
										false
										
									

									

										-MustFail
                                        
										If this rule is matched, then always fail to connect.
0 - Disabled (do not fail to connect)
1 - Enabled (fail to connect)		
										false
										false
										
									

									

										-OnlyOnFlag
                                        
										Only try to execute this rule if the specified flag is set by another rule (the OnlyOnFlag parameter is used in conjunction 
with the SetFlagOnMatch parameter).
Using the OnlyOnFlag and SetFlagOnMatch parameters, it is possible to make rules dependent on each other, that is, only 
execute a particular rule if another rule has been successfully matched ('chaining' rules). For more detailed instructions 
on ‘chaining’ rules, please refer to the Content Rules, Feature Description document on the Kemp Documentation Page: 
https://kemptechnologies.com/loadmaster-documentation/
Valid values: 0-9		
										false
										false
										
									

									

										-SetFlagOnMatch
                                        
										If the rule is successfully matched, set the specified flag. Using the OnlyOnFlag and SetFlagOnMatch parameters, it is 
possible to make rules dependent on each other, that is, only execute a particular rule if another rule has been 
successfully matched. For more detailed instructions on ‘chaining’ rules, please refer to the Content Rules, Feature 
Description document on the Kemp Documentation Page: https://kemptechnologies.com/loadmaster-documentation/.
Valid values: 0-9		
										false
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-Name
                                        
										The name of the rule.
										true
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

New-AdcContentRule -Name ExampleRule -MatchType regex -Pattern ExamplePattern -Replacement ExampleReplacement

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.

                            

						

                        
Top of page
				

				

					

						
 New-AdcHttpCacheException 

						
Add an extension to the "Do Not Cache" extension list.

						
Add the specified extension to the list.

					

                        

                        
 Syntax 

                        

						

                            


New-AdcHttpCacheException -Extension <String[]> [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

New-AdcHttpCacheException -Extension <String[]> [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation 
<String>] [-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-Extension
                                        
										The file extension that should not be cached, for example, .jpg. The extension must start with a full stop (.). A 
collection of extensions can be provided through the pipeline.		
										true
										true (ByValue)
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

New-AdcHttpCacheException -Extension .mp4

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.

                            

						

                        
Top of page
				

				

					

						
 New-AdcHttpCompressionException 

						
Allows you to add an extension to the "Do Not Compress" extension list.

						
Add the specified extension.

					

                        

                        
 Syntax 

                        

						

                            


New-AdcHttpCompressionException -Extension <String[]> [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

New-AdcHttpCompressionException -Extension <String[]> [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation 
<String>] [-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-Extension
                                        
										The file extension that should not be compressed, for example,.jpg. The extension must start with a full stop (.). A 
collection of extensions can be provided through the pipeline. This parameter is required.		
										true
										true (ByValue)
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

New-AdcHttpCompressionException -Extension .mp4

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.

                            

						

                        
Top of page
				

				

					

						
 New-AdcRealServer 

						
Add a new Real Server configuration.

						
Configures a new Real Server that can handle traffic for a service.

					

                        

                        
 Syntax 

                        

						

                            


New-AdcRealServer [-VirtualService <String>] [-VSPort <Int32>] [-VSProtocol <String>] [-VSIndex <Int32>] -RealServer 
<String> -RealServerPort <Int32> [-Weight <Int32>] [-Forward <String>] [-Enable <Boolean>] [-Non_Local <Boolean>] [-Limit 
<Int64>] [-Critical <Boolean>] [-AddToAllSubvs <Boolean>] [-Follow <Int32>] [-LoadBalancer <String>] [-LBPort <Int32>] 
[-Credential <Object>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

New-AdcRealServer [-VirtualService <String>] [-VSPort <Int32>] [-VSProtocol <String>] [-VSIndex <Int32>] -RealServer 
<String> -RealServerPort <Int32> [-Weight <Int32>] [-Forward <String>] [-Enable <Boolean>] [-Non_Local <Boolean>] [-Limit 
<Int64>] [-Critical <Boolean>] [-AddToAllSubvs <Boolean>] [-Follow <Int32>] [-LoadBalancer <String>] [-LBPort <Int32>] 
[-CertificateStoreLocation <String>] [-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable 
<String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-VirtualService
                                        
										The IP address of the Virtual Service.
										false
										false
										
									

									

										-VSPort
                                        
										The port of the Virtual Service to add the Real Server to.
										false
										false
										
									

									

										-VSProtocol
                                        
										The protocol of the Virtual Service to add the Real Server to.
										false
										false
										
									

									

										-VSIndex
                                        
										The index number of the Virtual Service or SubVS. To retrieve the VSIndex, run the Get-VirtualService command.
										false
										false
										
									

									

										-RealServer
                                        
										The IP address that the Real Server being defined listens on.
										true
										false
										
									

									

										-RealServerPort
                                        
										The port that the Real Server will be listening on.
										true
										false
										
									

									

										-Weight
                                        
										The Real Server's weight. This is weight of the Real Server, as used by the Weighted Round Robin, Weighted Least Connection 
and Adaptive scheduling methods. The default initial value for the weight is 1000, the maximum is 65535 and the minimum is 
1.		
										false
										false
										
									

									

										-Forward
                                        
										Either NAT (Network Address Translation) or Route (Direct) forwarding. The available options are dependent on the other 
modes configured for the service.		
										false
										false
										
									

									

										-Enable
                                        
										Specifies if the Real Server is enabled or disabled. Pass in a value of TRUE ($true) for enabled, and FALSE ($false) for 
disabled.		
										false
										false
										
									

									

										-Non_Local
                                        
										By default only Real Servers on local networks can be assigned to a Virtual Service. Enabling this option will allow a 
non-local Real Server to be assigned to the Virtual Service.


Note: This option will only be available if nonlocalrs has been enabled and the Transparent option has been disabled on the 
relevant Virtual Service.		
										false
										false
										
									

									

										-Limit
                                        
										The maximum number of open connections that a Real Server will accept before it is taken out of the rotation. This is only 
available for Layer 7 traffic.		
										false
										false
										
									

									

										-Critical
                                        
										True or false to indicate whether this Real Server is required for the Virtual Service to be available.
										false
										false
										
									

									

										-AddToAllSubvs
                                        
										Enable this option when adding a Real Server to all SubVSs of this Virtual Service. When using this parameter, ensure you 
set the VSIndex parameter to the ID of the SubVS rather than the parent Virtual Service. Run the Get-AdcVirtualService 
command to retrieve the Index of the SubVS.
The range is as follows:
0 - Disabled
1 - Enabled		
										false
										false
										
									

									

										-Follow
                                        
										Specify what Real Server the health check is based on by setting this parameter to the RsIndex of the Real Server to be 
followed. This can either be set to the RsIndex of the same Real Server in order to health check based on that particular 
Real Server status, or another Real Server can be specified. For example – if Real Server 1 is down, any Real Servers which 
have their health check based on Real Server 1 will also be marked as down, regardless of their actual Real Server status.		
										false
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-Port
                                        
										The port that the Virtual Service is listening on.
										false
										false
										
									

									

										-Protocol
                                        
										Specify if the service is using TCP or UDP protocols.
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

New-AdcRealServer -RealServer 10.154.11.128 -RealServerPort 443 -VirtualService 10.154.11.181 -VSPort 80 -VSProtocol tcp

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.
Data field...: @{RsSettings=}
Param........: @{Status=Down; VSIndex=1; RsIndex=1; Addr=10.154.11.128; Port=443; DnsName=; Forward=nat; Weight=1000; 
Limit=0; Follow=0; Enable=Y; Critical=N}

                            

						

                        
Top of page
				

				

					

						
 New-AdcRealServerRule 

						
Allows you to add a preconfigured rule to a Real Server.

						
Allows you to add a preconfigured rule to a Real Server or a SubVS.

					

                        

                        
 Syntax 

                        

						

                            


New-AdcRealServerRule [-VirtualService <String>] [-VSPort <Int32>] [-VSProtocol <String>] [-VSIndex <Int32>] [-RealServer 
<String>] [-RSPort <Int32>] [-RSIndex <Int32>] -RuleName <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential 
<Object>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

New-AdcRealServerRule [-VirtualService <String>] [-VSPort <Int32>] [-VSProtocol <String>] [-VSIndex <Int32>] [-RealServer 
<String>] [-RSPort <Int32>] [-RSIndex <Int32>] -RuleName <String> [-LoadBalancer <String>] [-LBPort <Int32>] 
[-CertificateStoreLocation <String>] [-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable 
<String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-VirtualService
                                        
										The IP Address of the Virtual Service this rule should be applied to.
										false
										false
										
									

									

										-VSPort
                                        
										The port of the relevant Virtual Service.
										false
										false
										
									

									

										-VSProtocol
                                        
										The protocol of the relevant Virtual Service.
										false
										false
										
									

									

										-VSIndex
                                        
										The index number of the relevant Virtual Service or SubVS. To retrieve the VSIndex, run the Get-VirtualService command.
										false
										false
										
									

									

										-RealServer
                                        
										The Real Server to which this Virtual Service connects to.
										false
										false
										
									

									

										-RSPort
                                        
										The port on which the Real Server accepts connections for this Virtual Service.
										false
										false
										
									

									

										-RSIndex
                                        
										The index number of the Real Server or SubVS to add the rule to. To retrieve the Real Server index, run the 
Get-VirtualService command.		
										false
										false
										
									

									

										-RuleName
                                        
										The name of the rule that should be applied to the Virtual Service.
										true
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-Port
                                        
										The port on which this Virtual Service accepts connections.
										false
										false
										
									

									

										-Protocol
                                        
										The protocol for communication. Accepts either TCP or UDP. This is not case sensitive.
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

New-AdcRealServerRule -Port 80 -Protocol tcp -RealServer 10.11.0.24 -RSPort 80 -RuleName TestRule2 -VirtualService 10.11.0.200

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.

                            

						

                        
Top of page
				

				

					

						
 New-AdcSubVirtualService 

						
Add a new SubVS.

						
This command adds a SubVS to the specified Virtual Service.

					

                        

                        
 Syntax 

                        

						

                            


New-AdcSubVirtualService [-VirtualService <String>] [-VSPort <Int32>] [-VSProtocol <String>] [-VSIndex <Int32>] 
[-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction <ActionPreference>] 
[-InformationVariable <String>] [<CommonParameters>]

New-AdcSubVirtualService [-VirtualService <String>] [-VSPort <Int32>] [-VSProtocol <String>] [-VSIndex <Int32>] 
[-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN <String>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-VirtualService
                                        
										The address of the Virtual Service to add the SubVS to.
										false
										false
										
									

									

										-VSPort
                                        
										The port of the Virtual Service to add the SubVS to.
										false
										false
										
									

									

										-VSProtocol
                                        
										The protocol of the Virtual Service to add the SubVS to.
										false
										false
										
									

									

										-VSIndex
                                        
										The ID number of the Virtual Service to add the SubVS to.
										false
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

New-AdcSubVirtualService -VirtualService 10.154.11.90 -VSPort 80 -VSProtocol tcp

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.
Status            : Down
Index             : 1
VSAddress         : 10.154.11.90
VSPort            : 80
Layer             : 7
Enable            : Y
SSLReverse        : N
SSLReencrypt      : N
Intercept         : N
InterceptOpts     : @{Opt=System.Object[]}
AlertThreshold    : 0
Transactionlimit  : 0
Transparent       : Y
SubnetOriginating : N
ServerInit        : 0
StartTLSMode      : 0
Idletime          : 660
Cache             : N
Compress          : N
Verify            : 0
UseforSnat        : N
ForceL4           : N
ForceL7           : Y
MultiConnect      : N
ClientCert        : 0
ErrorCode         : 0
CheckUse1.1       : N
MatchLen          : 0
CheckUseGet       : 0
SSLRewrite        : 0
VStype            : http
FollowVSID        : 0
Protocol          : tcp
Schedule          : rr
CheckType         : http
Persist           : header
PersistTimeout    : 360
CheckPort         : 0
NRules            : 0
NRequestRules     : 0
NResponseRules    : 0
NPreProcessRules  : 0
EspEnabled        : N
InputAuthMode     : 0
OutputAuthMode    : 0
MasterVS          : 1
MasterVSID        : 0
IsTransparent     : 0
AddVia            : 0
QoS               : 0
TlsType           : 0
NeedHostName      : N
OCSPVerify        : N
AllowHTTP2        : N
RsMinimum         : 0
NumberOfRSs       : 1
SubVS             : @{Status=Down; VSIndex=2; RsIndex=1; Name=-; Forward=nat; Weight=1000; Limit=0; Follow=0; Enable=Y; 
Critical=N}

                            

						

                        
Top of page
				

				

					

						
 New-AdcVirtualService 

						
Create and configure a new Virtual Service.

						
Creates a new Virtual Service that can accept requests and send them to available Real Servers.

					

                        

                        
 Syntax 

                        

						

                            


New-AdcVirtualService -VirtualService <String> -VSPort <Int32> -VSProtocol <String> [-AddVia <Int16>] [-Template <String>] 
[-Cache <Boolean>] [-CertFile <String>] [-CheckType <String>] [-CheckHost <String>] [-CheckPattern <String>] [-CheckUrl 
<String>] [-CheckHeaders <String>] [-LdapEndpoint <String>] [-MatchLen <String>] [-CheckUse1_1 <Int32>] [-CheckPort 
<Int32>] [-EnhancedHealthChecks <Boolean>] [-RsMinimum <Int32>] [-ClientCert <Int16>] [-Compress <Boolean>] [-Cookie 
<String>] [-CachePercent <Int16>] [-DefaultGW <String>] [-Enable <Boolean>] [-ErrorCode <String>] [-ErrorUrl <String>] 
[-PortFollow <Int32>] [-ForceL7 <Boolean>] [-Idletime <Int32>] [-LocalBindAddresses <String[]>] [-VSType <String>] 
[-Nickname <String>] [-Persist <String>] [-PersistTimeout <Int32>] [-QueryTag <String>] [-CipherSet <String>] 
[-SSLReencrypt <Boolean>] [-SSLReverse <Boolean>] [-SSLRewrite <String>] [-ReverseSNIHostname <String>] [-Schedule 
<String>] [-ServerInit <Int16>] [-SSLAcceleration <Boolean>] [-StandByAddr <String>] [-StandByPort <String>] 
[-TransactionLimit <Int32>] [-Transparent <Boolean>] [-SubnetOriginating <Boolean>] [-UseforSnat <Boolean>] [-QoS <String>] 
[-CheckUseGet <Int32>] [-Verify <Int16>] [-ExtraHdrKey <String>] [-ExtraHdrValue <String>] [-AllowedHosts <String>] 
[-AllowedDirectories <String>] [-ExcludedDirectories <String>] [-AllowedGroups <String>] [-GroupSIDs <String>] 
[-SteeringGroups <String>] [-IncludeNestedGroups <Boolean>] [-DisplayPubPriv <Boolean>] [-DisablePasswordForm <Boolean>] 
[-Domain <String>] [-AltDomains <String>] [-Logoff <String>] [-ESPLogs <Int16>] [-SMTPAllowedDomains <String>] [-ESPEnabled 
<Boolean>] [-UserPwdChangeUrl <String>] [-UserPwdChangeMsg <String>] [-SecurityHeaderOptions <Int16>] [-InputAuthMode 
<Int16>] [-OutConf <String>] [-OutputAuthMode <Int16>] [-StartTLSMode <Int16>] [-ExtraPorts <String>] [-AltAddress 
<String>] [-MultiConnect <Boolean>] [-SingleSignOnDir <String>] [-OCSPVerify <String>] [-FollowVSID <Int32>] [-TlsType 
<Int32>] [-CheckPostData <String>] [-CheckCodes <String>] [-PreProcPrecedence <String>] [-PreProcPrecedencePos <Int16>] 
[-RequestPrecedence <String>] [-RequestPrecedencePos <Int16>] [-ResponsePrecedence <String>] [-ResponsePrecedencePos 
<Int16>] [-RsRulePrecedence <String>] [-RsRulePrecedencePos <Int16>] [-NeedHostName <Boolean>] [-CopyHdrFrom <String>] 
[-CopyHdrTo <String>] [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

New-AdcVirtualService -VirtualService <String> -VSPort <Int32> -VSProtocol <String> [-AddVia <Int16>] [-Template <String>] 
[-Cache <Boolean>] [-CertFile <String>] [-CheckType <String>] [-CheckHost <String>] [-CheckPattern <String>] [-CheckUrl 
<String>] [-CheckHeaders <String>] [-LdapEndpoint <String>] [-MatchLen <String>] [-CheckUse1_1 <Int32>] [-CheckPort 
<Int32>] [-EnhancedHealthChecks <Boolean>] [-RsMinimum <Int32>] [-ClientCert <Int16>] [-Compress <Boolean>] [-Cookie 
<String>] [-CachePercent <Int16>] [-DefaultGW <String>] [-Enable <Boolean>] [-ErrorCode <String>] [-ErrorUrl <String>] 
[-PortFollow <Int32>] [-ForceL7 <Boolean>] [-Idletime <Int32>] [-LocalBindAddresses <String[]>] [-VSType <String>] 
[-Nickname <String>] [-Persist <String>] [-PersistTimeout <Int32>] [-QueryTag <String>] [-CipherSet <String>] 
[-SSLReencrypt <Boolean>] [-SSLReverse <Boolean>] [-SSLRewrite <String>] [-ReverseSNIHostname <String>] [-Schedule 
<String>] [-ServerInit <Int16>] [-SSLAcceleration <Boolean>] [-StandByAddr <String>] [-StandByPort <String>] 
[-TransactionLimit <Int32>] [-Transparent <Boolean>] [-SubnetOriginating <Boolean>] [-UseforSnat <Boolean>] [-QoS <String>] 
[-CheckUseGet <Int32>] [-Verify <Int16>] [-ExtraHdrKey <String>] [-ExtraHdrValue <String>] [-AllowedHosts <String>] 
[-AllowedDirectories <String>] [-ExcludedDirectories <String>] [-AllowedGroups <String>] [-GroupSIDs <String>] 
[-SteeringGroups <String>] [-IncludeNestedGroups <Boolean>] [-DisplayPubPriv <Boolean>] [-DisablePasswordForm <Boolean>] 
[-Domain <String>] [-AltDomains <String>] [-Logoff <String>] [-ESPLogs <Int16>] [-SMTPAllowedDomains <String>] [-ESPEnabled 
<Boolean>] [-UserPwdChangeUrl <String>] [-UserPwdChangeMsg <String>] [-SecurityHeaderOptions <Int16>] [-InputAuthMode 
<Int16>] [-OutConf <String>] [-OutputAuthMode <Int16>] [-StartTLSMode <Int16>] [-ExtraPorts <String>] [-AltAddress 
<String>] [-MultiConnect <Boolean>] [-SingleSignOnDir <String>] [-OCSPVerify <String>] [-FollowVSID <Int32>] [-TlsType 
<Int32>] [-CheckPostData <String>] [-CheckCodes <String>] [-PreProcPrecedence <String>] [-PreProcPrecedencePos <Int16>] 
[-RequestPrecedence <String>] [-RequestPrecedencePos <Int16>] [-ResponsePrecedence <String>] [-ResponsePrecedencePos 
<Int16>] [-RsRulePrecedence <String>] [-RsRulePrecedencePos <Int16>] [-NeedHostName <Boolean>] [-CopyHdrFrom <String>] 
[-CopyHdrTo <String>] [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN <String>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-VirtualService
                                        
										The IP address for the Virtual Service.
										true
										false
										
									

									

										-VSPort
                                        
										The port of the new Virtual Service.
										true
										false
										
									

									

										-VSProtocol
                                        
										The protocol of the new Virtual Service.
										true
										false
										
									

									

										-AddVia
                                        
										Specifies which headers are added to the HTTP stream. Choose the number of the option to use.


0 - Legacy Operation(XXX)
1 - None
2 - X-Forwarded-For
3 - X-Forwarded-For (No Via)
4 - X-ClientSide
5 - X-ClientSide (No Via)
6 - Via Only		
										false
										false
										
									

									

										-Template
                                        
										Specifies a template name.
										false
										false
										
									

									

										-Cache
                                        
										Enables or disables caching on this Virtual Service.
										false
										false
										
									

									

										-CertFile
                                        
										Specifies the name of the certificate file to use that is already installed on the load balancer. Note: This will NOT 
upload a certificate file to the load balancer.		
										false
										false
										
									

									

										-CheckType
                                        
										Specifies the protocol to use to check if the service is up. Valid options are "tcp", "icmp", "https", "http", "smtp", 
"nntp", "ftp", "telnet", "pop3", "imap", "rdp", or "none".		
										false
										false
										
									

									

										-CheckHost
                                        
										The address to use to check if the service is up.
										false
										false
										
									

									

										-CheckPattern
                                        
										A regular expression string that can be validate on a 200 reply to determine if the service is up.
										false
										false
										
									

									

										-CheckUrl
                                        
										The URL to check if the service is up. The maximum character length for the CheckUrl parameter value is 126 characters.
										false
										false
										
									

									

										-CheckHeaders
                                        
										Specify up to four additional headers/fields which will be sent with each health check request. Separate the pairs with a 
pipe, for example; Host:xyc|UserAgent:prq.		
										false
										false
										
									

									

										-LdapEndpoint
                                        
										Specify the name of an LDAP endpoint to use for the health checks. If LDAP is selected as the CheckType, the server IP 
address (or addresses) and ports from the LDAP endpoint configuration are used instead of the Real Server IP address and 
port.		
										false
										false
										
									

									

										-MatchLen
                                        
										This parameter is only relevant when the CheckType is set to "bdata". Specify the number of bytes to find the CheckPattern 
within.		
										false
										false
										
									

									

										-CheckUse1_1
                                        
										Specifies that the health checker use HTTP/1.1 instead of HTTP/1.0. By default, the health checker uses HTTP/1.0 when 
checking the Real Server status. Enabling CheckUse1_1 means HTTP/1.1 is used (which is more efficient).
Note: Optimization only works on HTTP (not HTTPS) connections.
0 - HTTP/1.0
1 - HTTP/1.1		
										false
										false
										
									

									

										-CheckPort
                                        
										The port to use to check if the service is up.
										false
										false
										
									

									

										-EnhancedHealthChecks
                                        
										Enables or disables Enhanced Health Check Options for the Virtual Service.
										false
										false
										
									

									

										-RsMinimum
                                        
										Specifies the minimum number of Real Servers that are required to be active for the Virtual Service to be considered up.
										false
										false
										
									

									

										-ClientCert
                                        
										Specify how client certificates should be used. Valid values are 0, 1, or 2. Zero indicates that client certificates are 
not use. One indicates that client certificates are required. Two indicates that client certificates are required and 
additional HEAD information is being sent.		
										false
										false
										
									

									

										-Compress
                                        
										Enable or disable file compression for the Virtual Service.
										false
										false
										
									

									

										-Cookie
                                        
										Specifies a cookie name. This parameter is only relevant when the persistence mode is set to "cookie", "active-cookie", 
"cookie-src" or "active-cook-src".		
										false
										false
										
									

									

										-CachePercent
                                        
										Specifies the maximum cache usage for this Virtual Service. Note: Setting two Virtual Services using 50% of cache will use 
100% of all cache storage. This parameter accepts values from 0 to 100.		
										false
										false
										
									

									

										-DefaultGW
                                        
										Specifies a Virtual Service-specific default gateway to be used to send responses back to clients. If not set, the global 
default gateway will be used.		
										false
										false
										
									

									

										-Enable
                                        
										Enables or disables the Virtual Service.
										false
										false
										
									

									

										-ErrorCode
                                        
										If no Real Servers are available, the LoadMaster can terminate the connection with an HTTP error code. Specify the error 
code number in this parameter.		
										false
										false
										
									

									

										-ErrorUrl
                                        
										When no Real Servers are available and an error response is sent back to the client, a redirect URL can also be specified.
										false
										false
										
									

									

										-PortFollow
                                        
										This parameter was depreciated as of 7.1-24. For LoadMasters with version 7.1-24 or higher, use the FollowVSID parameter to 
set port following.		
										false
										false
										
									

									

										-ForceL7
                                        
										Enabling ForceL7 means the Virtual Service runs at Layer 7 and not Layer 4. This may be needed for various reasons, 
including that only Layer 7 services can be non-transparent.		
										false
										false
										
									

									

										-Idletime
                                        
										Specifies the length of time (in seconds) that a connection may remain idle before it is closed. The range for this 
parameter is 0 to 86400. 
Setting the Idletime to 0 ensures the default L7 connection timeout is used. You can modify the default timeout value by 
setting the conntimeout parameter.		
										false
										false
										
									

									

										-LocalBindAddresses
                                        
										Specifies a space separated list of IP addresses. This corresponds to the Alternate Source Address in the Advanced 
Properties section of the WUI. Allow connections scaling over 64K Connections needs to be enabled in L7 Configuration for 
this feature to work.		
										false
										false
										
									

									

										-VSType
                                        
										Specifies the type of service being load balanced:


gen - Generic
http - HTTP/HTTPS
ts - Remote Terminal
tls – STARTTLS protocols
log – Log Insight		
										false
										false
										
									

									

										-Nickname
                                        
										Specifies the "friendly" name of the service. In addition to the usual alphanumeric characters, the following "special" 
characters can be used as part of the Service Name:


. @ - _


However, there must be at least one alphanumeric character before the special characters.		
										false
										false
										
									

									

										-Persist
                                        
										Specifies the type of persistence (stickiness) to be used for this Virtual Service.


The following persistence values are supported: ssl, cookie, active-cookie, cookie-src, active-cook-src, cookie-hash, 
cookie-hash-src, url, query-hash, host, header, super, super-src, src, rdp, rdp-src, rdp-sb, rdp-sb-src and udpsip.


Note: If setting the persistence mode to an option that requires a cookie (or query-hash), the cookie parameter must also 
be set.		
										false
										false
										
									

									

										-PersistTimeout
                                        
										The length of time (in seconds) after the last connection that the LoadMaster will remember the persistence information. 
Timeout values are rounded down to an even number of minutes. Setting a value that is not a number of whole minutes results 
in the excess being ignored. Setting a value to less than 60 seconds results in a value of 0 being set, which disables 
persistency.		
										false
										false
										
									

									

										-QueryTag
                                        
										This is the query tag to be matched if the Persist type is set to query-hash.
										false
										false
										
									

									

										-CipherSet
                                        
										Specifies a cipher set name.
										false
										false
										
									

									

										-SSLReencrypt
                                        
										This parameter is only relevant if SSL Acceleration is enabled. When this option is enabled, the SSL data stream is 
re-encrypted before sending to the Real Server.		
										false
										false
										
									

									

										-SSLReverse
                                        
										Enabling this parameter means that the data from the LoadMaster to the Real Server is re-encrypted.
										false
										false
										
									

									

										-SSLRewrite
                                        
										When the Real Server rejects a request with an HTTP redirect, the requesting Location URL may need to be converted to 
specify HTTPS instead of HTTP (and vice versa).		
										false
										false
										
									

									

										-ReverseSNIHostname
                                        
										If this option is enabled, the host name is required to be sent in the TLS client hello message. If it is not sent the 
connection will be dropped.		
										false
										false
										
									

									

										-Schedule
                                        
										Specifies the type of scheduling of new connections to Real Servers that is to be performed. The following values are 
supported:


rr = round robin
wrr = weighted round robin
lc = least connection
wlc = weighted least connection
fixed = fixed weighting
adaptive = resource based (adaptive)
sh = source IP hash
dl = weighted response time
sdn-adaptive = resource based (SDN adaptive)		
										false
										false
										
									

									

										-ServerInit
                                        
										Specifies one of the following values:


0 = Normal Protocols
1 = SMTP
2 = SSH
3 = Other Server Initiating
4 = IMAP4
5 = MySQL
6 = POP3		
										false
										false
										
									

									

										-SSLAcceleration
                                        
										Specifies whether to enable SSL handling on the Virtual Service.
										false
										false
										
									

									

										-StandByAddr
                                        
										Specifies the IP address of the "Sorry" server that is to be used when no other Real Servers are available. This server 
will not be health checked and is assumed to be always available.		
										false
										false
										
									

									

										-StandByPort
                                        
										Specifies the port of the "Sorry" server.
										false
										false
										
									

									

										-TransactionLimit
                                        
										This is a legacy parameter that should no longer be used. It was used previously when the SSL proxy was limited to 6K total 
connections. The transaction limit was used to limit one Virtual Service to only handle so many connections out of this 6K. 
On newer systems, where the limit is greater than 64K - this feature is no longer required.		
										false
										false
										
									

									

										-Transparent
                                        
										When using Layer 7, when this is enabled - the connection arriving at the Real Server appears to come directly from the 
client. Alternatively, the connection can be non-transparent, which means that the connections at the Real Server appear to 
come from the LoadMaster.
0 - Disabled
1 - Enabled
If a Virtual Service (with or without a SubVS) has SSL re-encrypt enabled, the transparency flag of the Virtual Service has 
no meaning (re-encryption forces transparency to be off). The transparency setting can still be modified by the API, and is 
honored when re-encrypt is disabled on the Virtual Service.		
										false
										false
										
									

									

										-SubnetOriginating
                                        
										When transparency is not enabled, the source IP address of connections to the Real Servers is that of the Virtual Service. 
When transparency is enabled, the source IP address will be the IP address that is initiating connection to the Virtual 
Service. If the Real Server is on a subnet, and the Subnet Originating Requests option is enabled, then the subnet address 
of the LoadMaster will be used as the source IP address.		
										false
										false
										
									

									

										-UseforSnat
                                        
										By default, when the LoadMaster is being used to NAT Real Servers, the source IP address used on the Internet is that of 
the LoadMaster. Enabling this option allows the Real Servers configured to use the Virtual Service as the source IP address 
instead. If the Real Servers are configured on more than one Virtual Service which has this option set, only connections to 
destination port 80 will use this Virtual Service as the source IP address.		
										false
										false
										
									

									

										-QoS
                                        
										Specifies the Quality of Service. The following values are supported:


0 - Normal-Service
1 - Minimize-Cost
2 - Maximize-Reliability
4 - Maximize-Throughput
8 - Minimize-Delay		
										false
										false
										
									

									

										-CheckUseGet
                                        
										When accessing the health check URL - the system can use the HEAD, the GET or the POST method:
0 - HEAD
1 - GET
2 - POST		
										false
										false
										
									

									

										-Verify
                                        
										Specifies a verification bitmask. The valid values of the Verify parameter are as follows:


Bit 0: set this to 1 to enable detection intrusion.


Note: Bit 0 needs to be set to 1 in order to use the other two bits.


Bit 1: Determines whether to reject or drop a connection. Setting it to 1 will drop the connection.


Bit 2: Determines whether to give just warnings on bad requests or also on malicious (but not invalid) requests.


The following table lists the valid integers and the values they set the fields to when used:  
Integer       Detect Malicious Requests           Intrusion Handling          Warnings Checkbox
0             Disabled                            N/A                         N/A
1             Enabled                             Drop Connection             Unchecked
2             Enabled                             Send Reject                 Unchecked
3             Enabled                             Send Reject                 Unchecked
4             Enabled                             Drop Connection             Checked
5             Enabled                             Drop Connection             Checked
6             Enabled                             Send Reject                 Checked
7             Enabled                             Send Reject                 Checked		
										false
										false
										
									

									

										-ExtraHdrKey
                                        
										Specifies the key for the extra header to be inserted into every request sent to the Real Servers.
										false
										false
										
									

									

										-ExtraHdrValue
                                        
										Specifies the value for the extra header to be inserted into every request sent to the Real Servers.
										false
										false
										
									

									

										-AllowedHosts
                                        
										This parameter is only relevant when ESP is enabled. Specifies all the virtual hosts that can be accessed via this Virtual 
Service.		
										false
										false
										
									

									

										-AllowedDirectories
                                        
										This parameter is only relevant when ESP is enabled. Specifies all the virtual directories that can be accessed via this 
Virtual Service.		
										false
										false
										
									

									

										-ExcludedDirectories
                                        
										This parameter is only relevant when ESP is enabled. Any virtual directories specified within this field will not be 
pre-authorized on this Virtual Service and are passed directly to the relevant Real Servers.		
										false
										false
										
									

									

										-AllowedGroups
                                        
										Specifies the groups that are allowed to access this Virtual Service.
										false
										false
										
									

									

										-GroupSIDs
                                        
										Specify the group security identifier (SIDs) that are allowed to access this Virtual Service. Each group must be separated 
by a semicolon.		
										false
										false
										
									

									

										-SteeringGroups
                                        
										Enter the Active Directory group names that will be used for steering traffic. Use a semi-colon to separate multiple group 
names. The steering group index number corresponds to the location of the group in this list.		
										false
										false
										
									

									

										-IncludeNestedGroups
                                        
										Specify if nested groups should be included in the authentication attempt.
										false
										false
										
									

									

										-DisplayPubPriv
                                        
										Display the public/private option on the login page. Based on the option the user selects on the login form, the session 
timeout value will be set to the value specified for either the public or private timeout.		
										false
										false
										
									

									

										-DisablePasswordForm
                                        
										Enabling this option removes the password field from the login page. This may be needed when password validation is not 
required, for example if using RSA SecurID authentication in a singular fashion.		
										false
										false
										
									

									

										-Domain
                                        
										Specifies the Single Sign On (SSO) domain in which this Virtual Service will operate.
										false
										false
										
									

									

										-AltDomains
                                        
										Specifies alternative domains to be assigned to a Virtual Service when configuring multi-domain authentication. To specify 
multiple alternative domains use a space-separated list.		
										false
										false
										
									

									

										-Logoff
                                        
										This parameter is only relevant when ESP is enabled and when the Client Authentication Mode is set to Form Based. Specify 
the string that the LoadMaster should use to detect a logout event. Multiple logoff strings can be specified by using a 
space-separated list.


If the URL to be matched contains sub-directories before the specified string, the Logoff String will not be matched. 
Therefore the LoadMaster will not log the user off.


You can specify up to 255 characters for this parameter.		
										false
										false
										
									

									

										-ESPLogs
                                        
										Enable ESP logging. Valid values are below:


0 - Logging off
1 - User Access
2 - Security
3 - User Access and Security
4 - Connection
5 - User Access and Connection
6 - Security and connection
7 - User Access, Security and Connection


Note: The only valid values for SMTP services are 0 and 4. For SMTP services, security issues are always logged. Nothing is 
logged for user access because there are no logins.		
										false
										false
										
									

									

										-SMTPAllowedDomains
                                        
										Specifies all the permitted domains that are allowed to be received by this Virtual Service.
										false
										false
										
									

									

										-ESPEnabled
                                        
										Specifies whether to enable or disable the Edge Security Pack (ESP) features.
										false
										false
										
									

									

										-UserPwdChangeUrl
                                        
										This is relevant when using form-based or LDAP authentication. Specify the URL that users can use to change their password. 
If a user’s password has expired, or if they must reset their password, this URL and the UserPwdChangeMsg is displayed on 
the login form.
This URL must be put into the exception list for authentication, if required.		
										false
										false
										
									

									

										-UserPwdChangeMsg
                                        
										This parameter is only relevant if the UserPwdChangeURL parameter is set. Specify the text to be displayed on the login 
form when the user must reset their password.		
										false
										false
										
									

									

										-SecurityHeaderOptions
                                        
										Enable this option to add the Strict-Transport-Security header to all LoadMaster-generated messages (ESP and error 
messages).
0 - Don't add the Strict Transport Security Header (default value)
1 - Add the Strict Transport Security Header - no subdomains
2 - Add the Strict Transport Security Header - include subdomains Enable this option to add the Strict-Transport-Security 
header to all LoadMaster-generated messages (ESP and error messages).		
										false
										false
										
									

									

										-InputAuthMode
                                        
										Specifies the client authentication method to be used:


0 - Delegate to Server
1 - Basic Authentication
2 - Form Based
4 - Client Certificate
5 - NTLM
6 - SAML		
										false
										false
										
									

									

										-OutConf
                                        
										Enter the name of the outbound SSO domain.
										false
										false
										
									

									

										-OutputAuthMode
                                        
										Specifies the server authentication mode to be used:


0 - None
1 - Basic Authentication
2 - Form Based
3 - KCD
4 - Server Token		
										false
										false
										
									

									

										-StartTLSMode
                                        
										0 - HTTP/HTTPS (the Service Type needs to be set to HTTP/HTTPS for this to work)


The Virtual Service Type must be set to STARTTLS for the remaining values to be set:


1 - SMTP (STARTTLS if requested)
2 - SMTP (STARTTLS always)
3 - FTP
4 - IMAP
6 - POP3		
										false
										false
										
									

									

										-ExtraPorts
                                        
										Specifies extra ports that the Virtual Service will listen to.
										false
										false
										
									

									

										-AltAddress
                                        
										Specifies the alternate address for this Virtual Service.
										false
										false
										
									

									

										-MultiConnect
                                        
										Enabling this option permits the LoadMaster to manage connection handling between the LoadMaster and the Real Servers. 
Requests from multiple clients will be sent over the same TCP connection.


Multiplexing only works for simple HTTP GET operations. This parameter cannot be enabled in certain situations, for example 
if WAF, ESP or SSL Acceleration is enabled.		
										false
										false
										
									

									

										-SingleSignOnDir
                                        
										This parameter relates to the SSO Image Set drop-down in the ESP Options section of the modify Virtual Service screen. 
Specify the name of the image set to be used for the login screen. If no image set is specified, the default Exchange image 
set will be used.		
										false
										false
										
									

									

										-OCSPVerify
                                        
										Specifies whether to verify (via Online Certificate Status Protocol (OCSP)) that the client certificate is valid.
										false
										false
										
									

									

										-FollowVSID
                                        
										Specifies the ID of the Virtual Service to follow.
										false
										false
										
									

									

										-TlsType
                                        
										Specify which of the following protocols to support; SSLv3, TLS1.0, TLS1.1, TLS1.2, or TLS1.3. By default, TLS1.1, TLS1.2, 
and TLS1.3 are enabled. The protocols can be enabled and disabled using a bitmask value. Refer to the table below to find 
out what number corresponds to which settings.


Number |   SSLv3      | TLS1.0     | TLS1.1      | TLS1.2         | TLS1.3
0            |   Enabled   | Enabled  | Enabled   | Enabled       |  Enabled
1            |   Disabled  | Enabled  | Enabled   | Enabled       | Enabled
2            |   Enabled   | Disabled | Enabled   | Enabled       | Enabled
3            |   Disabled  | Disabled | Enabled   | Enabled       | Enabled
4            |   Enabled   | Enabled  | Disabled  | Enabled       | Enabled
5            |   Disabled  | Enabled  | Disabled  | Enabled       | Enabled
6            |   Enabled   | Disabled | Disabled  | Enabled       | Enabled
7            |   Disabled  | Disabled | Disabled  | Enabled       | Enabled
8            |   Enabled   | Enabled  | Enabled   | Disabled      | Enabled
9            |   Disabled  | Enabled  | Enabled   | Disabled      | Enabled
10          |   Enabled   | Disabled | Enabled   | Disabled      | Enabled
11          |   Disabled  | Disabled | Enabled   | Disabled      | Enabled
12          |   Enabled   | Enabled  | Disabled  | Disabled      | Enabled
13          |   Disabled  | Enabled  | Disabled  | Disabled      | Enabled
14          |   Enabled   | Disabled | Disabled  | Disabled      | Enabled
15          |   Disabled  | Disabled | Disabled  | Disabled      | Enabled
16          |   Enabled   | Enabled  | Enabled   | Enabled       | Disabled
17          |   Disabled |  Enabled  | Enabled   | Enabled       | Disabled
18          |   Enabled  |  Disabled | Enabled   | Enabled       | Disabled
19          |   Disabled |  Disabled | Enabled   | Enabled       | Disabled
20          |   Enabled  |  Enabled  | Disabled  | Enabled       | Disabled
21          |   Disabled |  Enabled  | Disabled  | Enabled       | Disabled
22          |   Enabled  |  Disabled | Disabled  | Enabled       | Disabled
23          |   Disabled |  Disabled | Disabled  | Enabled       | Disabled
24          |   Enabled  |   Enabled | Enabled   | Disabled      | Disabled
25          |   Disabled |   Enabled | Enabled   | Disabled      | Disabled
26          |   Enabled  |   Disabled | Enabled  | Disabled      | Disabled
27          |   Disabled |   Disabled | Enabled  | Disabled      | Disabled
28          |   Enabled  |   Enabled  | Disabled | Disabled      | Disabled
29          |   Disabled |   Enabled  | Disabled | Disabled      | Disabled
30          |   Enabled  |   Disabled | Disabled | Disabled      | Disabled		
										false
										false
										
									

									

										-CheckPostData
                                        
										This parameter is only relevant if the HTTP Method is set to POST. When using the POST method, up to 2047 characters of 
POST data can be sent to the server.		
										false
										false
										
									

									

										-CheckCodes
                                        
										A space-separated list of HTTP status codes that should be treated as successful when received from the Real Server.
Range: 300-599		
										false
										false
										
									

									

										-PreProcPrecedence
                                        
										This parameter should be used in conjunction with PreProcPrecedencePos. This parameter is used to specify the name of the 
existing rule whose position you wish to change. This parameter relates to Content Matching Rules only.		
										false
										false
										
									

									

										-PreProcPrecedencePos
                                        
										This parameter, in conjunction with the PreProcPrecedence parameter, is used to change the position of the rule in a 
sequence of rules. For example a position of 2 means the rule will be checked second. This parameter relates to the Content 
Matching Rules only.		
										false
										false
										
									

									

										-RequestPrecedence
                                        
										This parameter should be used in conjunction with RequestPrecedencePos. This parameter is used to specify the name of the 
existing request rule whose position you wish to change.


This parameter relates to the following rule types:


Content Matching
Add Header
Delete Header
Replace Header
Modify URL		
										false
										false
										
									

									

										-RequestPrecedencePos
                                        
										This parameter, in conjunction with the RequestPrecedence parameter, is used to change the position of the rule in a 
sequence of rules. For example a position of 2 means the rule will be checked second.		
										false
										false
										
									

									

										-ResponsePrecedence
                                        
										This parameter should be used in conjunction with ResponsePrecedencePos. This parameter is used to specify the name of the 
existing response rule whose position you wish to change.


This parameter relates to the following rule types:


Content Matching
Add Header
Delete Header
Replace Header		
										false
										false
										
									

									

										-ResponsePrecedencePos
                                        
										This parameter, in conjunction with the ResponsePrecedence parameter, is used to change the position of the rule in a 
sequence of rules. For example, a position of 2 means the rule will be checked second.		
										false
										false
										
									

									

										-RsRulePrecedence
                                        
										This parameter should be used in conjunction with RSRulePrecedencePos. This parameter is used to specify the name of the 
existing rule whose position you wish to change.		
										false
										false
										
									

									

										-RsRulePrecedencePos
                                        
										This parameter, in conjunction with the RSRulePrecedence parameter, is used to change the position of the rule in a 
sequence of rules. For example, a position of 2 means the rule will be checked second.		
										false
										false
										
									

									

										-NeedHostName
                                        
										When this parameter is enabled, the hostname is always required to be sent in the TLS client hello message. If it is not 
sent, the connection is dropped.
Valid values:
0 - Disabled
1 - Enabled		
										false
										false
										
									

									

										-CopyHdrFrom
                                        
										This is the name of the source header field to copy into the new header field before the request is sent to the Real 
Servers.		
										false
										false
										
									

									

										-CopyHdrTo
                                        
										This parameter is used in conjunction with the CopyHdrFrom parameter.
The name of the header field into which the source header is to be copied.		
										false
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-Port
                                        
										The port that the Virtual Service is listening on.
										true
										false
										
									

									

										-Protocol
                                        
										Specify if the service is using TCP or UDP protocols.
										true
										false
										
									

									

										-DisplayPasswordForm
                                        
										Enabling this option removes the password field from the login page. This may be needed when password validation is not 
required, for example if using RSA SecurID authentication in a singular fashion.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

New-AdcVirtualService -Port 80 -Protocol tcp -VirtualService 10.154.11.234

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.

                            

						

                        
Top of page
				

				

					

						
 New-AdcVirtualServiceResponseBodyRule 

						
Add a response body modification rule to the specified Virtual Service.

						
Use this command to associate an existing response body modification rule to an existing Virtual Service.

					

                        

                        
 Syntax 

                        

						

                            


New-AdcVirtualServiceResponseBodyRule -VSIndex <Int32> -RuleName <String> [-LoadBalancer <String>] [-LBPort <Int32>] 
[-Credential <Object>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

New-AdcVirtualServiceResponseBodyRule -VSIndex <Int32> -RuleName <String> [-LoadBalancer <String>] [-LBPort <Int32>] 
[-CertificateStoreLocation <String>] [-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable 
<String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-VSIndex
                                        
										The index number of the Virtual Service to add the content rule to.
										true
										false
										
									

									

										-RuleName
                                        
										The name of the response body modification rule to add to the Virtual Service.
										true
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

New-AdcVirtualServiceResponseBodyRule -RuleName ExampleBodyRule -VSIndex 1

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.

                            

						

                        
Top of page
				

				

					

						
 New-AdcVirtualServiceRule 

						
Add a content rule to a Virtual Service.

						
Add the specified content rule to a Virtual Service.

					

                        

                        
 Syntax 

                        

						

                            


New-AdcVirtualServiceRule [-VirtualService <String>] [-VSPort <Int32>] [-VSProtocol <String>] [-VSIndex <Int32>] -RuleType 
<String> -RuleName <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

New-AdcVirtualServiceRule [-VirtualService <String>] [-VSPort <Int32>] [-VSProtocol <String>] [-VSIndex <Int32>] -RuleType 
<String> -RuleName <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN 
<String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-VirtualService
                                        
										The IP address of the Virtual Service to add the content rule to.
										false
										false
										
									

									

										-VSPort
                                        
										The port of the Virtual Service to add the content rule to.
										false
										false
										
									

									

										-VSProtocol
                                        
										The port of the Virtual Service to add the content rule to.
										false
										false
										
									

									

										-VSIndex
                                        
										The index number of the Virtual Service to add the content rule to.
										false
										false
										
									

									

										-RuleType
                                        
										The type of content rule to add to the Virtual Service.
										true
										false
										
									

									

										-RuleName
                                        
										The name of the content rule to add to the Virtual Service.
										true
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

New-AdcVirtualServiceRule -RuleName ActiveSync_1041 -RuleType request -VirtualService 10.154.11.181 -VSPort 443 -VSProtocol tcp

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.

                            

						

                        
Top of page
				

				

					

						
 New-AdcVsWafRule 

						
Assigns Web Application Firewall (WAF) rules to the specified Virtual Service.

						
Add the specified WAF rule to the specified Virtual Service.

					

                        

                        
 Syntax 

                        

						

                            


New-AdcVsWafRule -VS <String> -VSPort <String> -VSProtocol <String> -Rule <String> [-Enablerules <String>] [-Disablerules 
<String>] [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction <ActionPreference>] 
[-InformationVariable <String>] [<CommonParameters>]

New-AdcVsWafRule -VS <String> -VSPort <String> -VSProtocol <String> -Rule <String> [-Enablerules <String>] [-Disablerules 
<String>] [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN <String>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-VS
                                        
										The IP address of the relevant Virtual Service.
										true
										false
										
									

									

										-VSPort
                                        
										Specifies the port on which this Virtual Service accepts connections.
										true
										false
										
									

									

										-VSProtocol
                                        
										Specifies the communication protocol of the Virtual Service. Valid options are TCP or UDP (not case sensitive).
										true
										false
										
									

									

										-Rule
                                        
										Specify the name of the rule to be assigned.
The rule name must be preceded with a letter/word and a forward slash. The letter used depends on the type of rule being 
added:
  - C or Custom
  - Z  or ApplicationGeneric
  - A or ApplicationSpecific
  - G or Generic		
										true
										false
										
									

									

										-Enablerules
                                        
										Specific rules can be enabled per ruleset by specifying the rule IDs to be enabled. Multiple rules can be enabled by using 
a comma-separated list. To retrieve the rule IDs, run the Get-WAFVSRules command.
To only update rules (and not rulesets), run the New-AdcWafRule command with a blank Rule parameter.
To enable all rules, run the New-AdcWafRule command with blank rule and disablerules parameters.		
										false
										false
										
									

									

										-Disablerules
                                        
										Specific rules can be disabled per ruleset by specifying the rule IDs to be disabled. Multiple rules can be disabled by 
using a comma-separated list. To retrieve the rule IDs, run the Get-WAFVSRules command.
To only update rules (and not rulesets), run the Add-AdcWafRule command with a blank Rule parameter.
To remove all disabled rules (i.e. enable all rules), run the Add-AdcWafRule command with blank rule and disablerules 
parameters.		
										false
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

New-AdcVsWafRule -Rule G/ip_reputation -VS 10.35.47.86 -VSPort 80 -VSProtocol tcp

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed; Data=}
Return Code..: 200
Response.....: Command successfully executed

                            

						

                        
Top of page
				

				

					

						
 New-Certificate 

						
WARNING: This function is deprecated. Use the following command instead:
New-TlsCertificate

						
WARNING: This function is deprecated. Use the following command instead:
New-TlsCertificate

					

                        

                        
 Syntax 

                        

						

                            


New-Certificate -Name <String> [-Password <String>] [-Replace <SwitchParameter>] -Path <String> [-LoadBalancer <String>] 
[-LBPort <Int32>] [-Credential <Object>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] 
[<CommonParameters>]

New-Certificate -Name <String> [-Password <String>] [-Replace <SwitchParameter>] -Path <String> [-LoadBalancer <String>] 
[-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN <String>] [-InformationAction <ActionPreference>] 
[-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-Name
                                        
										
										true
										false
										
									

									

										-Password
                                        
										
										false
										false
										
									

									

										-Replace
                                        
										
										false
										false
										
									

									

										-Path
                                        
										
										true
										false
										
									

									

										-LoadBalancer
                                        
										
										false
										false
										
									

									

										-LBPort
                                        
										
										false
										false
										
									

									

										-Credential
                                        
										
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										
										false
										false
										
									

									

										-SubjectCN
                                        
										
										false
										false
										
									

								
							

						
				
				

				

					

						
 New-Cluster 

						
Converts the LoadMaster to cluster mode.

						
Converts the LoadMaster to cluster mode.

					

                        

                        
 Syntax 

                        

						

                            


New-Cluster -SharedAddress <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

New-Cluster -SharedAddress <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] 
[-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-SharedAddress
                                        
										The initial shared IP address of the cluster.
										true
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

New-Cluster -SharedAddress 10.11.0.31

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.

                            

						

                        
Top of page
				

				

					

						
 New-ClusterNode 

						
Adds a LoadMaster to a cluster.

						
Adds a single node LoadMaster (which is available to be added) to the cluster.


Before running this command, run the Join-Cluster command on the LoadMaster node to be added to the cluster in a different 
console window. This makes the node LoadMaster available to be added. To finish adding the node, then run the 
New-ClusterNode command on the shared IP address immediately after running the Join-Cluster command in a different console 
window.

					

                        

                        
 Syntax 

                        

						

                            


New-ClusterNode -Address <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

New-ClusterNode -Address <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] 
[-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-Address
                                        
										The IP address of the node LoadMaster.
										true
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

New-ClusterNode -Address 10.35.47.15 -LoadBalancer -10.35.47.100 -Credential bal

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.

                            

						

                        
Top of page
				

				

					

						
 New-GeoCluster 

						
Add a new GEO cluster.

						
Run this command to add a new GEO cluster to the LoadMaster.

					

                        

                        
 Syntax 

                        

						

                            


New-GeoCluster -ClusterIp <String> -ClusterName <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

New-GeoCluster -ClusterIp <String> -ClusterName <String> [-LoadBalancer <String>] [-LBPort <Int32>] 
[-CertificateStoreLocation <String>] [-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable 
<String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-ClusterIp
                                        
										The IP address of the GEO cluster.
										true
										false
										
									

									

										-ClusterName
                                        
										The name of the GEO cluster.
										true
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

New-GeoCluster -ClusterIp 10.34.52.56 -ClusterName ExampleCluster2

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.

                            

						

                        
Top of page
				

				

					

						
 New-GeoCustomLocation 

						
Add a new custom location.

						
Creates a custom GEO location which can be selected when using the Location Based selection criteria.

					

                        

                        
 Syntax 

                        

						

                            


New-GeoCustomLocation -Location <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

New-GeoCustomLocation -Location <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] 
[-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-Location
                                        
										The name of the custom location.
										true
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

New-GeoCustomLocation -Location "New York"

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.

                            

						

                        
Top of page
				

				

					

						
 New-GeoDNSSECKeySigningKey 

						
Generate the Key Signing Key (KSK).

						
Generate the KSK.

					

                        

                        
 Syntax 

                        

						

                            


New-GeoDNSSECKeySigningKey [-SigningAlgorithm <String>] [-SigningKeySize <Int32>] [-LoadBalancer <String>] [-LBPort 
<Int32>] [-Credential <Object>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

New-GeoDNSSECKeySigningKey [-SigningAlgorithm <String>] [-SigningKeySize <Int32>] [-LoadBalancer <String>] [-LBPort 
<Int32>] [-CertificateStoreLocation <String>] [-SubjectCN <String>] [-InformationAction <ActionPreference>] 
[-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-SigningAlgorithm
                                        
										Specify the cryptographic algorithm to use. If this parameter is omitted, the default value is used.
Valid values are:
RSASHA256
NSEC3RSASHA1
NSEC3RSASHA1


The default value is RSASHA256.		
										false
										false
										
									

									

										-SigningKeySize
                                        
										Specify the key size (in bits). If this parameter is omitted, the default value is used.
Valid values are:
1024
2048
4096


The default value is 2048.		
										false
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

New-GeoDNSSECKeySigningKey -SigningAlgorithm RSASHA512 -SigningKeySize 2048

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.

                            

						

                        
Top of page
				

				

					

						
 New-GeoFQDN 

						
Add an FQDN.

						
Add a new GEO FQDN.

					

                        

                        
 Syntax 

                        

						

                            


New-GeoFQDN -FQDN <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

New-GeoFQDN -FQDN <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN 
<String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-FQDN
                                        
										The name of the FQDN.
										true
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

New-GeoFQDN -FQDN ExampleFQDN.com

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed. Added FQDN ExampleFQDN.com; Data=}
Return Code..: 200
Response.....: Command successfully executed. Added FQDN ExampleFQDN.com

                            

						

                        
Top of page
				

				

					

						
 New-GeoFQDNSiteAddress 

						
Add an IP address to an FQDN.

						
Run this command to add the specified IP address to the relevant GEO FQDN.

					

                        

                        
 Syntax 

                        

						

                            


New-GeoFQDNSiteAddress -FQDN <String> -SiteAddress <String> [-Cluster <String>] [-LoadBalancer <String>] [-LBPort <Int32>] 
[-Credential <Object>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

New-GeoFQDNSiteAddress -FQDN <String> -SiteAddress <String> [-Cluster <String>] [-LoadBalancer <String>] [-LBPort <Int32>] 
[-CertificateStoreLocation <String>] [-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable 
<String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-FQDN
                                        
										The name of the FQDN.
										true
										false
										
									

									

										-SiteAddress
                                        
										The address to be added to the FQDN.
										true
										false
										
									

									

										-Cluster
                                        
										If needed, enter the cluster name where the IP address is located.
										false
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

New-GeoFQDNSiteAddress -FQDN Example.com -SiteAddress 10.134.33.2

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed. Added site 10.134.33.3 to FQDN Example.com; Data=}
Return Code..: 200
Response.....: Command successfully executed. Added site 10.134.33.3 to FQDN Example.com

                            

						

                        
Top of page
				

				

					

						
 New-GeoIpRange 

						
Add an IP address to the IP range selection criteria list.

						
Add an IP address to the IP range selection criteria list.

					

                        

                        
 Syntax 

                        

						

                            


New-GeoIpRange -IP <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

New-GeoIpRange -IP <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN 
<String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-IP
                                        
										String IP address of the IP range.
										true
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

New-GeoIpRange -IP 10.145.32.4

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed. IP range added; Data=}
Return Code..: 200
Response.....: Command successfully executed. IP range added

                            

						

                        
Top of page
				

				

					

						
 New-GeoIPWhitelist 

						
Add an IP address or network to the whitelist.

						
Run this command to add an IP address or network to the user-defined whitelist. The whitelist entries override the 
blacklist.

					

                        

                        
 Syntax 

                        

						

                            


New-GeoIPWhitelist -Addr <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

New-GeoIPWhitelist -Addr <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] 
[-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-Addr
                                        
										The address or network to be added to the GEO Access Control whitelist.
										true
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

New-GeoIPWhitelist -Addr 10.145.33.22

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed. 10.145.33.22 was successfully added to GEO ACL 
white list.; Data=}
Return Code..: 200
Response.....: Command successfully executed. 10.145.33.22 was successfully added to GEO ACL white list.

                            

						

                        
Top of page
				

				

					

						
 New-GlobalPacketFilterACL 

						
Adds an address to the global black or white list.

						
Adds a host or network IP address to the global black or white Access Control List (ACL).  Note that black and white lists 
are only enabled when packet filtering is enabled.

					

                        

                        
 Syntax 

                        

						

                            


New-GlobalPacketFilterACL -Type <String> -Address <String> [-Comment <String>] [-LoadBalancer <String>] [-LBPort <Int32>] 
[-Credential <Object>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

New-GlobalPacketFilterACL -Type <String> -Address <String> [-Comment <String>] [-LoadBalancer <String>] [-LBPort <Int32>] 
[-CertificateStoreLocation <String>] [-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable 
<String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-Type
                                        
										Specifies the access control list type: black or white.
										true
										false
										
									

									

										-Address
                                        
										Specifies a host or network IP address to add to the access control list. The address can be specified in CIDR format. If 
the CIDR is not specified, the system uses a default of /32.		
										true
										false
										
									

									

										-Comment
                                        
										Optionally add a comment about the entry. This parameter accepts a maximum of 127 characters.
										false
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

New-GlobalPacketFilterACL -Type black -Address 10.35.47.16

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.

                            

						

                        
Top of page
				

				

					

						
 New-HostsEntry 

						
Adds a host IP address and host FQDN.

						
Add a new address for local resolution.

					

                        

                        
 Syntax 

                        

						

                            


New-HostsEntry -HostIP <String> -HostFQDN <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

New-HostsEntry -HostIP <String> -HostFQDN <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation 
<String>] [-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-HostIP
                                        
										Specify the IP address for the entry.
										true
										false
										
									

									

										-HostFQDN
                                        
										Specify the host FQDN for the entry.
										true
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

New-HostsEntry -HostFQDN example2.com -HostIP 10.154.11.38

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.

                            

						

                        
Top of page
				

				

					

						
 New-IntermediateCertificate 

						
WARNING: This function is deprecated. Use the following command instead:
New-TlsIntermediateCertificate

						
WARNING: This function is deprecated. Use the following command instead:
New-TlsIntermediateCertificate

					

                        

                        
 Syntax 

                        

						

                            


New-IntermediateCertificate [-Name <String>] [-Path <String>] [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential 
<Object>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

New-IntermediateCertificate [-Name <String>] [-Path <String>] [-LoadBalancer <String>] [-LBPort <Int32>] 
[-CertificateStoreLocation <String>] [-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable 
<String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-Name
                                        
										
										false
										false
										
									

									

										-Path
                                        
										
										false
										false
										
									

									

										-LoadBalancer
                                        
										
										false
										false
										
									

									

										-LBPort
                                        
										
										false
										false
										
									

									

										-Credential
                                        
										
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										
										false
										false
										
									

									

										-SubjectCN
                                        
										
										false
										false
										
									

								
							

						
				
				

				

					

						
 New-LdapEndpoint 

						
Add a new LDAP endpoint.

						
These LDAP endpoints may be used in three different areas:
• Health checks
• SSO domains
• WUI authentication

					

                        

                        
 Syntax 

                        

						

                            


New-LdapEndpoint -Name <String> [-Server <String>] [-LdapProtocol <String>] [-VInterval <Int16>] [-ReferralCount <Int16>] 
[-Timeout <Int16>] [-AdminUser <String>] [-AdminPass <String>] [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential 
<Object>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

New-LdapEndpoint -Name <String> [-Server <String>] [-LdapProtocol <String>] [-VInterval <Int16>] [-ReferralCount <Int16>] 
[-Timeout <Int16>] [-AdminUser <String>] [-AdminPass <String>] [-LoadBalancer <String>] [-LBPort <Int32>] 
[-CertificateStoreLocation <String>] [-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable 
<String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-Name
                                        
										The desired name for the new LDAP endpoint. This name cannot contain any spaces.
										true
										false
										
									

									

										-Server
                                        
										Specify the address, or addresses, of the LDAP server to be used. You can also specify a port number, if desired. Separate 
multiple addresses with a space.		
										false
										false
										
									

									

										-LdapProtocol
                                        
										Specify the transport protocol to use when communicating with the LDAP server. Valid values are:
Unencrypted (default)
StartTLS
LDAPS		
										false
										false
										
									

									

										-VInterval
                                        
										Specify how often to revalidate the user the with the LDAP server.
Range: 10 – 86400 seconds
Default: 60		
										false
										false
										
									

									

										-ReferralCount
                                        
										To disable referral chasing, set this to 0. To enable referral chasing, set this to a value between 1 and 10. Referral 
chasing limits the number of hops.
Note: Multiple hops may increase authentication latency.		
										false
										false
										
									

									

										-Timeout
                                        
										Specify the LDAP server timeout in seconds. The default value is 5. Valid values range from 5 to 60.
										false
										false
										
									

									

										-AdminUser
                                        
										Specify the username of an administrator user. The username that will be used to check the LDAP server.
										false
										false
										
									

									

										-AdminPass
                                        
										Specify the password for the specified administrator user. The password that will be used to check the LDAP server.
										false
										false
										
									

									

										-LoadBalancer
                                        
										The IP address of the Kemp LoadMaster that you are directing the command to. This can be set globally by using the 
Initialize-LoadBalancer command, but can be overridden on each individual command by using this parameter.		
										false
										false
										
									

									

										-LBPort
                                        
										The port of the load balancer.
										false
										false
										
									

									

										-Credential
                                        
										Specifies a user account that has permission to administer the load balancer. You can either enter a username for the load 
balancer or provide a PSCredential object, such as an object that is returned by the Get-Credential cmdlet. When you type a 
username, you are prompted for a password.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\&lt;CurrentUser&gt;\TrustedPeople.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

New-LdapEndpoint -Name Example3 -AdminPass examplePassword -AdminUser ExampleUser -LdapProtocol StartTLS -Server 10.154.22.11

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.

                            

						

                        
Top of page
				

				

					

						
 New-LmIPConnectionLimit 

						
Add an IP address to be limited.

						
Specify an IP address to be limited.

					

                        

                        
 Syntax 

                        

						

                            


New-LmIPConnectionLimit -L7addr <String> -L7limit <Int32> [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

New-LmIPConnectionLimit -L7addr <String> -L7limit <Int32> [-LoadBalancer <String>] [-LBPort <Int32>] 
[-CertificateStoreLocation <String>] [-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable 
<String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-L7addr
                                        
										Add the IP address or network to be limited.
										true
										false
										
									

									

										-L7limit
                                        
										Limit the number of connection attempts (per second) from a specific host/network.
										true
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

New-LmIpConnectionLimit -L7addr 10.134.55.23 -L7limit 100

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.

                            

						

                        
Top of page
				

				

					

						
 New-LmVpnConnection 

						
Creates a new Virtual Private Network (VPN) connection.

						
Run this command to create a new VPN connection.

					

                        

                        
 Syntax 

                        

						

                            


New-LmVpnConnection -Name <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

New-LmVpnConnection -Name <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] 
[-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-Name
                                        
										The name of the VPN.
										true
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

New-LmVpnConnection -Name ExampleVPNConnection

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.

                            

						

                        
Top of page
				

				

					

						
 New-NetworkBondedInterface 

						
Add a standalone interface to a bonded interface.

						
The Register-NetworkBondedInterface command must be run before running this command.

					

                        

                        
 Syntax 

                        

						

                            


New-NetworkBondedInterface -InterfaceID <Int16> -BondID <Int16> [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential 
<Object>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

New-NetworkBondedInterface -InterfaceID <Int16> -BondID <Int16> [-LoadBalancer <String>] [-LBPort <Int32>] 
[-CertificateStoreLocation <String>] [-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable 
<String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-InterfaceID
                                        
										The Interface ID of the Bonded Interface. To view the interface ID for each of the interfaces, run the 
Get-LmNetworkInterface command.		
										true
										false
										
									

									

										-BondID
                                        
										The Interface ID of the interface to link to the bonded interface.
										true
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

New-NetworkBondedInterface -InterfaceID 1 -BondID 2

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.
Data field...: @{Interface=}

Id               : 1
IPAddress        : 
NBondMembers     : 2
BondMembers      : @{RealInterface=System.Object[]}
Mode             : 802.3ad
InterfaceType    : Bonded
GeoTrafficEnable : no
DefaultInterface : no

                            

						

                        
Top of page
				

				

					

						
 New-NetworkInterfaceAdditionalAddress 

						
Add an additional address to an interface.

						
Specify an additional address to be used on the interface.

					

                        

                        
 Syntax 

                        

						

                            


New-NetworkInterfaceAdditionalAddress [-InterfaceID <Int16>] [-Address <String>] [-LoadBalancer <String>] [-LBPort <Int32>] 
[-Credential <Object>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

New-NetworkInterfaceAdditionalAddress [-InterfaceID <Int16>] [-Address <String>] [-LoadBalancer <String>] [-LBPort <Int32>] 
[-CertificateStoreLocation <String>] [-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable 
<String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-InterfaceID
                                        
										The ID number of the interface to add the additional address to.
										false
										false
										
									

									

										-Address
                                        
										The additional address to be added.
										false
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

New-NetworkInterfaceAdditionalAddress -Address 10.154.11.22

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.
Id                  : 0
IPAddress           : 10.154.11.180/16
Mtu                 : 1400
AdditionalAddresses : @{IPaddress=10.154.11.22/16}
InterfaceType       : Port
GeoTrafficEnable    : yes
DefaultInterface    : yes

                            

						

                        
Top of page
				

				

					

						
 New-NetworkRoute 

						
Add a new IP route to the load balancer.

						
Adds an IP route to the routing table on the load balancer.

					

                        

                        
 Syntax 

                        

						

                            


New-NetworkRoute -Destination <String> -CIDR <Int16> -Gateway <String> [-LoadBalancer <String>] [-LBPort <Int32>] 
[-Credential <Object>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

New-NetworkRoute -Destination <String> -CIDR <Int16> -Gateway <String> [-LoadBalancer <String>] [-LBPort <Int32>] 
[-CertificateStoreLocation <String>] [-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable 
<String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-Destination
                                        
										The destination network that needs to be reached.
										true
										false
										
									

									

										-CIDR
                                        Mask, SubnetMask
										The subnet mask of the destination address/network.
										true
										false
										
									

									

										-Gateway
                                        
										The interface to be used to direct traffic to the desired network.
										true
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

New-NetworkRoute -CIDR 16 -Destination 10.154.11.33 -Gateway 10.154.11.23

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.
Data field...: @{Route=System.Object[]}
Destination : 10.154.11.24/16
Gateway     : 10.154.11.44

Destination : 10.154.11.33/16
Gateway     : 10.154.11.23

                            

						

                        
Top of page
				

				

					

						
 New-NetworkVLAN 

						
Allows you to add a Virtual LAN.

						
Add a VLAN.

					

                        

                        
 Syntax 

                        

						

                            


New-NetworkVLAN -InterfaceID <Int16> -VLanId <Int16> [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

New-NetworkVLAN -InterfaceID <Int16> -VLanId <Int16> [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation 
<String>] [-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-InterfaceID
                                        
										The ID of the interface to be added to the VLAN.
										true
										false
										
									

									

										-VLanId
                                        
										The ID of the VLAN.
										true
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Add-NetworkVLAN -InterfaceID 1 -VLAN 1

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.
Data field...: @{Interface=}
Id               : 2
IPAddress        : 
VlanId           : 1
RealInterface    : 1
InterfaceType    : Vlan
GeoTrafficEnable : no
DefaultInterface : no

                            

						

                        
Top of page
				

				

					

						
 New-NetworkVxLAN 

						
Creates a new VXLAN interface.

						
Run this command to create a new VXLAN interface.

					

                        

                        
 Syntax 

                        

						

                            


New-NetworkVxLAN -InterfaceID <Int16> -VNI <Int32> -Addr <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential 
<Object>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

New-NetworkVxLAN -InterfaceID <Int16> -VNI <Int32> -Addr <String> [-LoadBalancer <String>] [-LBPort <Int32>] 
[-CertificateStoreLocation <String>] [-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable 
<String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-InterfaceID
                                        
										The ID of the interface to add the VXLAN to.
										true
										false
										
									

									

										-VNI
                                        
										The VxLAN Network Identifier.
										true
										false
										
									

									

										-Addr
                                        
										The multicast group or remote address.
										true
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Add-NetworkVxLAN -Addr 10.154.11.34 -InterfaceID 1 -VNI 1

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.
Data field...: @{Interface=}
Id               : 2
IPAddress        : 
VNI              : 1
RemoteAddress    : 10.154.11.34
RealInterface    : 1
InterfaceType    : VXlan
GeoTrafficEnable : no
DefaultInterface : no

                            

						

                        
Top of page
				

				

					

						
 New-RealServer 

						
WARNING: This function is deprecated. Use the following command instead:
New-AdcRealServer

						
WARNING: This function is deprecated. Use the following command instead:
New-AdcRealServer

					

                        

                        
 Syntax 

                        

						

                            


New-RealServer [-VirtualService <String>] [-VSPort <Int32>] [-VSProtocol <String>] [-VSIndex <Int32>] -RealServer <String> 
-RealServerPort <Int32> [-Weight <Int32>] [-Forward <String>] [-Enable <Boolean>] [-Non_Local <Boolean>] [-Limit <Int64>] 
[-Critical <Boolean>] [-Follow <Int32>] [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

New-RealServer [-VirtualService <String>] [-VSPort <Int32>] [-VSProtocol <String>] [-VSIndex <Int32>] -RealServer <String> 
-RealServerPort <Int32> [-Weight <Int32>] [-Forward <String>] [-Enable <Boolean>] [-Non_Local <Boolean>] [-Limit <Int64>] 
[-Critical <Boolean>] [-Follow <Int32>] [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] 
[-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-VirtualService
                                        
										
										false
										false
										
									

									

										-VSPort
                                        
										
										false
										false
										
									

									

										-VSProtocol
                                        
										
										false
										false
										
									

									

										-VSIndex
                                        
										
										false
										false
										
									

									

										-RealServer
                                        
										
										true
										false
										
									

									

										-RealServerPort
                                        
										
										true
										false
										
									

									

										-Weight
                                        
										
										false
										false
										
									

									

										-Forward
                                        
										
										false
										false
										
									

									

										-Enable
                                        
										
										false
										false
										
									

									

										-Non_Local
                                        
										
										false
										false
										
									

									

										-Limit
                                        
										
										false
										false
										
									

									

										-Critical
                                        
										
										false
										false
										
									

									

										-Follow
                                        
										
										false
										false
										
									

									

										-LoadBalancer
                                        
										
										false
										false
										
									

									

										-LBPort
                                        
										
										false
										false
										
									

									

										-Credential
                                        
										
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										
										false
										false
										
									

									

										-SubjectCN
                                        
										
										false
										false
										
									

								
							

						
				
				

				

					

						
 New-RealServerRule 

						
WARNING: This function is deprecated. Use the following command instead:
New-AdcRealServerRule

						
WARNING: This function is deprecated. Use the following command instead:
New-AdcRealServerRule

					

                        

                        
 Syntax 

                        

						

                            


New-RealServerRule [-VirtualService <String>] [-VSPort <Int32>] [-VSProtocol <String>] [-VSIndex <Int32>] [-RealServer 
<String>] [-RSPort <Int32>] [-RSIndex <Int32>] -RuleName <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential 
<Object>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

New-RealServerRule [-VirtualService <String>] [-VSPort <Int32>] [-VSProtocol <String>] [-VSIndex <Int32>] [-RealServer 
<String>] [-RSPort <Int32>] [-RSIndex <Int32>] -RuleName <String> [-LoadBalancer <String>] [-LBPort <Int32>] 
[-CertificateStoreLocation <String>] [-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable 
<String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-VirtualService
                                        
										
										false
										false
										
									

									

										-VSPort
                                        
										
										false
										false
										
									

									

										-VSProtocol
                                        
										
										false
										false
										
									

									

										-VSIndex
                                        
										
										false
										false
										
									

									

										-RealServer
                                        
										
										false
										false
										
									

									

										-RSPort
                                        
										
										false
										false
										
									

									

										-RSIndex
                                        
										
										false
										false
										
									

									

										-RuleName
                                        
										
										true
										false
										
									

									

										-LoadBalancer
                                        
										
										false
										false
										
									

									

										-LBPort
                                        
										
										false
										false
										
									

									

										-Credential
                                        
										
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										
										false
										false
										
									

									

										-SubjectCN
                                        
										
										false
										false
										
									

								
							

						
				
				

				

					

						
 New-Route 

						
WARNING: This function is deprecated. Use the following command instead:
New-NetworkRoute

						
WARNING: This function is deprecated. Use the following command instead:
New-NetworkRoute

					

                        

                        
 Syntax 

                        

						

                            


New-Route -Destination <String> -CIDR <Int16> -Gateway <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential 
<Object>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

New-Route -Destination <String> -CIDR <Int16> -Gateway <String> [-LoadBalancer <String>] [-LBPort <Int32>] 
[-CertificateStoreLocation <String>] [-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable 
<String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-Destination
                                        
										
										true
										false
										
									

									

										-CIDR
                                        Mask, SubnetMask
										
										true
										false
										
									

									

										-Gateway
                                        
										
										true
										false
										
									

									

										-LoadBalancer
                                        
										
										false
										false
										
									

									

										-LBPort
                                        
										
										false
										false
										
									

									

										-Credential
                                        
										
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										
										false
										false
										
									

									

										-SubjectCN
                                        
										
										false
										false
										
									

								
							

						
				
				

				

					

						
 New-Rule 

						
WARNING: This function is deprecated. Use the following command instead:
New-AdcContentRule

						
WARNING: This function is deprecated. Use the following command instead:
New-AdcContentRule

					

                        

                        
 Syntax 

                        

						

                            


New-Rule -RuleName <String> [-MatchType <String>] [-IncHost <Boolean>] [-NoCase <Boolean>] [-Negate <Boolean>] [-IncQuery 
<Boolean>] [-Header <String>] [-Pattern <String>] [-Replacement <String>] [-Type <Int32>] [-LoadBalancer <String>] [-LBPort 
<Int32>] [-Credential <Object>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

New-Rule -RuleName <String> [-MatchType <String>] [-IncHost <Boolean>] [-NoCase <Boolean>] [-Negate <Boolean>] [-IncQuery 
<Boolean>] [-Header <String>] [-Pattern <String>] [-Replacement <String>] [-Type <Int32>] [-LoadBalancer <String>] [-LBPort 
<Int32>] [-CertificateStoreLocation <String>] [-SubjectCN <String>] [-InformationAction <ActionPreference>] 
[-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-RuleName
                                        
										
										true
										false
										
									

									

										-MatchType
                                        
										
										false
										false
										
									

									

										-IncHost
                                        
										
										false
										false
										
									

									

										-NoCase
                                        
										
										false
										false
										
									

									

										-Negate
                                        
										
										false
										false
										
									

									

										-IncQuery
                                        
										
										false
										false
										
									

									

										-Header
                                        
										
										false
										false
										
									

									

										-Pattern
                                        
										
										false
										false
										
									

									

										-Replacement
                                        
										
										false
										false
										
									

									

										-Type
                                        
										
										false
										false
										
									

									

										-LoadBalancer
                                        
										
										false
										false
										
									

									

										-LBPort
                                        
										
										false
										false
										
									

									

										-Credential
                                        
										
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										
										false
										false
										
									

									

										-SubjectCN
                                        
										
										false
										false
										
									

								
							

						
				
				

				

					

						
 New-SdnController 

						
Add an SDN controller to the LoadMaster.

						
Add the specified controller.

					

                        

                        
 Syntax 

                        

						

                            


New-SdnController -IPV4 <String> -Port <Int32> [-Clid <Int32>] [-Https <Boolean>] [-User <String>] [-Password <String>] 
[-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction <ActionPreference>] 
[-InformationVariable <String>] [<CommonParameters>]

New-SdnController -IPV4 <String> -Port <Int32> [-Clid <Int32>] [-Https <Boolean>] [-User <String>] [-Password <String>] 
[-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN <String>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-IPV4
                                        
										The IPv4 address of the SDN controller.
										true
										false
										
									

									

										-Port
                                        
										The port of the SDN controller.
										true
										false
										
									

									

										-Clid
                                        
										The cluster ID for the new SDN controller. If a number is specified, the SDN controller will be added to the cluster with 
the relevant ID number. The cluster with the ID number specified must already exist.
If a number is not specified, the SDN controller will be added to a new cluster.		
										false
										false
										
									

									

										-Https
                                        
										The HTTP method to use.
0 - HTTP
1 - HTTPS		
										false
										false
										
									

									

										-User
                                        
										The username to be used to access the SDN controller RESTful API.
										false
										false
										
									

									

										-Password
                                        
										The password to be used to access the SDN controller RESTful API.
										false
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

New-SdnController -IPV4 10.123.2.2 -Port 80

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=Data}
Return Code..: 200
Response.....: Command successfully executed.

                            

						

                        
Top of page
				

				

					

						
 New-SecRemoteUserGroup 

						
Add a new remote user group.

						
These groups can be used to provide WUI authentication.

					

                        

                        
 Syntax 

                        

						

                            


New-SecRemoteUserGroup -Group <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

New-SecRemoteUserGroup -Group <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] 
[-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-Group
                                        
										Enter the name of the new group to add.
The following characters are permitted in the group nameL alphanumeric characters, spaces, or the following special 
symbols: =~^._+#,@/-.		
										true
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

New-SecRemoteUserGroup -Group ExampleGroup4

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.

                            

						

                        
Top of page
				

				

					

						
 New-SecUser 

						
Allows you to add a new local user.

						
Allows you to add a new local user.

					

                        

                        
 Syntax 

                        

						

                            


New-SecUser -User <String> [-Password <String>] [-Radius <Boolean>] [-NoPassword <SwitchParameter>] [-LoadBalancer 
<String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] 
[<CommonParameters>]

New-SecUser -User <String> [-Password <String>] [-Radius <Boolean>] [-NoPassword <SwitchParameter>] [-LoadBalancer 
<String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN <String>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-User
                                        
										Username for the new user.
										true
										false
										
									

									

										-Password
                                        
										Password for the new user.
										false
										false
										
									

									

										-Radius
                                        
										The radius parameter determines whether the user will use RADIUS server authentication or not when logging in to the 
LoadMaster. The RADIUS server details must be set up before this option can be used.
0 - Do not use RADIUS authentication
1 - Use RADIUS authentication		
										false
										false
										
									

									

										-NoPassword
                                        
										This option is only valid if session management is enabled. Set this option to yes to create a user with no password. This 
can be used to allow certificate-based access.		
										false
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

New-SecUser -Password password1234 -Radius 0 -User ExampleUsername

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.

                            

						

                        
Top of page
				

				

					

						
 New-SecUserCertificate 

						
Generate a new certificate for a user.

						
Generate a new certificate for a user.

					

                        

                        
 Syntax 

                        

						

                            


New-SecUserCertificate -User <String> [-Passphrase <String>] [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential 
<Object>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

New-SecUserCertificate -User <String> [-Passphrase <String>] [-LoadBalancer <String>] [-LBPort <Int32>] 
[-CertificateStoreLocation <String>] [-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable 
<String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-User
                                        
										The username of the user to generate the certificate for.
										true
										false
										
									

									

										-Passphrase
                                        
										The passphrase is optional. If entered, it will be used to encrypt the private key.
										false
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

New-SecUserCertificate -User Example

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.

                            

						

                        
Top of page
				

				

					

						
 New-SSODomain 

						
Allows you to create a new Single Sign-On (SSO) Domain.

						
Allows you to create a new Single Sign-On (SSO) Domain.

					

                        

                        
 Syntax 

                        

						

                            


New-SSODomain [-Domain <String>] [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] 
[-CertificateStoreLocation <String>] [-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable 
<String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-Domain
                                        Name
										Specifies the name of the SSO domain LoadMaster entry to be modified. You can specify up to 64 characters in the domain 
parameter.		
										false
										true (ByPropertyName)
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

								
							

						
				
						

                            

                                
 Note 

                            

							
You can only use one login method - either certificate or credential. You cannot use both.

						

                        

                            
 Examples 

                        

						

                            

							    Example

New-SSODomain -Domain example3.com

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed (Domain "example3.com" created); Data=}
Return Code..: 200
Response.....: Command successfully executed (Domain "example3.com" created)

                            

						

                        
Top of page
				

				

					

						
 New-TlsCertificate 

						
Allows you to add a certificate to the LoadMaster.

						
Allows you to add a certificate to the LoadMaster.

					

                        

                        
 Syntax 

                        

						

                            


New-TlsCertificate -Name <String> [-Password <String>] [-Replace <SwitchParameter>] -Path <String> [-LoadBalancer <String>] 
[-LBPort <Int32>] [-Credential <Object>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] 
[<CommonParameters>]

New-TlsCertificate -Name <String> [-Password <String>] [-Replace <SwitchParameter>] -Path <String> [-LoadBalancer <String>] 
[-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN <String>] [-InformationAction <ActionPreference>] 
[-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-Name
                                        
										The identifier that the certificate is known as on the LoadMaster.
										true
										false
										
									

									

										-Password
                                        
										The password for the certificate file to be uploaded.
										false
										false
										
									

									

										-Replace
                                        
										Specifies if this certificate replaces an existing certificate already installed.
										false
										false
										
									

									

										-Path
                                        
										The local path to the certificate file. The certificate file can be either .PEM or .PFX (IIS) format
										true
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

New-TlsCertificate -Name mycert -Password password -Path "C:\certs\mycert.pem"

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.

                            

						

                        
Top of page
				

				

					

						
 New-TlsHSMClientCert 

						
WARNING: This function is not available. The Hardware Security Module (HSM) feature has been removed from the LoadMaster.

						
This command will not work on LoadMaster versions 7.2.46.0 and newer. If you want to use PowerShell to configure HSM on an 
older LoadMaster 
version, use the PowerShell module corresponding to that version, for example PowerShell-7.2.45.

					

                        

                        
 Syntax 

                        

						

                            


New-TlsHSMClientCert -Path <String> -Clcertname <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] 
[-Force <SwitchParameter>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

New-TlsHSMClientCert -Path <String> -Clcertname <String> [-LoadBalancer <String>] [-LBPort <Int32>] 
[-CertificateStoreLocation <String>] [-SubjectCN <String>] [-Force <SwitchParameter>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-Path
                                        
										The path to where you want the generated certificate file to be downloaded to.
										true
										false
										
									

									

										-Clcertname
                                        
										Provide a name for the generated file.
										true
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-Force
                                        
										Enable this parameter to force the command to execute without a confirmation.
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

New-TlsHSMClientCert –Clcertname <CertificateName> -Path “<PathToDownloadTheGeneratedFileTo>”

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.

                            

						

                        
Top of page
				

				

					

						
 New-TlsIntermediateCertificate 

						
Allows you to add a certificate to the LoadMaster.

						
Allows you to add a certificate to the LoadMaster.

					

                        

                        
 Syntax 

                        

						

                            


New-TlsIntermediateCertificate [-Name <String>] [-Path <String>] [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential 
<Object>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

New-TlsIntermediateCertificate [-Name <String>] [-Path <String>] [-LoadBalancer <String>] [-LBPort <Int32>] 
[-CertificateStoreLocation <String>] [-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable 
<String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-Name
                                        
										The name of the intermediate certificate to be added to the LoadMaster.
										false
										false
										
									

									

										-Path
                                        
										The local path to the intermediate certificate file.
										false
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

New-TlsIntermediateCertificate -Name certificate.pem -Password password -Path "C:\certs\certificates"

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.

                            

						

                        
Top of page
				

				

					

						
 New-VirtualService 

						
WARNING: This function is deprecated. Use the following command instead:
New-AdcVirtualService

						
WARNING: This function is deprecated. Use the following command instead:
New-AdcVirtualService

					

                        

                        
 Syntax 

                        

						

                            


New-VirtualService -VirtualService <String> -VSPort <Int32> -VSProtocol <String> [-AddVia <Int16>] [-Template <String>] 
[-Cache <Boolean>] [-CertFile <String>] [-CheckType <String>] [-CheckHost <String>] [-CheckPattern <String>] [-CheckUrl 
<String>] [-CheckHeaders <String>] [-LdapEndpoint <String>] [-MatchLen <String>] [-CheckUse1_1 <Int32>] [-CheckPort 
<Int32>] [-EnhancedHealthChecks <Boolean>] [-RsMinimum <Int32>] [-ClientCert <Int16>] [-Compress <Boolean>] [-Cookie 
<String>] [-CachePercent <Int16>] [-DefaultGW <String>] [-Enable <Boolean>] [-ErrorCode <String>] [-ErrorUrl <String>] 
[-PortFollow <Int32>] [-ForceL7 <Boolean>] [-Idletime <Int32>] [-LocalBindAddresses <String[]>] [-VSType <String>] 
[-Nickname <String>] [-Persist <String>] [-PersistTimeout <Int32>] [-QueryTag <String>] [-CipherSet <String>] 
[-SSLReencrypt <Boolean>] [-SSLReverse <Boolean>] [-SSLRewrite <String>] [-ReverseSNIHostname <String>] [-Schedule 
<String>] [-ServerInit <Int16>] [-SSLAcceleration <Boolean>] [-StandByAddr <String>] [-StandByPort <String>] 
[-TransactionLimit <Int32>] [-Transparent <Boolean>] [-SubnetOriginating <Boolean>] [-UseforSnat <Boolean>] [-QoS <String>] 
[-CheckUseGet <Int32>] [-Verify <Int16>] [-ExtraHdrKey <String>] [-ExtraHdrValue <String>] [-AllowedHosts <String>] 
[-AllowedDirectories <String>] [-AllowedGroups <String>] [-GroupSIDs <String>] [-IncludeNestedGroups <Boolean>] 
[-DisplayPubPriv <Boolean>] [-DisablePasswordForm <Boolean>] [-Domain <String>] [-AltDomains <String>] [-Logoff <String>] 
[-ESPLogs <Int16>] [-SMTPAllowedDomains <String>] [-ESPEnabled <Boolean>] [-UserPwdChangeUrl <String>] [-UserPwdChangeMsg 
<String>] [-InputAuthMode <Int16>] [-OutputAuthMode <Int16>] [-StartTLSMode <Int16>] [-ExtraPorts <String>] [-AltAddress 
<String>] [-MultiConnect <Boolean>] [-SingleSignOnDir <String>] [-OCSPVerify <String>] [-FollowVSID <Int32>] [-TlsType 
<Boolean>] [-CheckPostData <String>] [-CheckCodes <String>] [-PreProcPrecedence <String>] [-PreProcPrecedencePos <Int16>] 
[-RequestPrecedence <String>] [-RequestPrecedencePos <Int16>] [-ResponsePrecedence <String>] [-ResponsePrecedencePos 
<Int16>] [-RsRulePrecedence <String>] [-RsRulePrecedencePos <Int16>] [-NeedHostName <Boolean>] [-CopyHdrFrom <String>] 
[-CopyHdrTo <String>] [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

New-VirtualService -VirtualService <String> -VSPort <Int32> -VSProtocol <String> [-AddVia <Int16>] [-Template <String>] 
[-Cache <Boolean>] [-CertFile <String>] [-CheckType <String>] [-CheckHost <String>] [-CheckPattern <String>] [-CheckUrl 
<String>] [-CheckHeaders <String>] [-LdapEndpoint <String>] [-MatchLen <String>] [-CheckUse1_1 <Int32>] [-CheckPort 
<Int32>] [-EnhancedHealthChecks <Boolean>] [-RsMinimum <Int32>] [-ClientCert <Int16>] [-Compress <Boolean>] [-Cookie 
<String>] [-CachePercent <Int16>] [-DefaultGW <String>] [-Enable <Boolean>] [-ErrorCode <String>] [-ErrorUrl <String>] 
[-PortFollow <Int32>] [-ForceL7 <Boolean>] [-Idletime <Int32>] [-LocalBindAddresses <String[]>] [-VSType <String>] 
[-Nickname <String>] [-Persist <String>] [-PersistTimeout <Int32>] [-QueryTag <String>] [-CipherSet <String>] 
[-SSLReencrypt <Boolean>] [-SSLReverse <Boolean>] [-SSLRewrite <String>] [-ReverseSNIHostname <String>] [-Schedule 
<String>] [-ServerInit <Int16>] [-SSLAcceleration <Boolean>] [-StandByAddr <String>] [-StandByPort <String>] 
[-TransactionLimit <Int32>] [-Transparent <Boolean>] [-SubnetOriginating <Boolean>] [-UseforSnat <Boolean>] [-QoS <String>] 
[-CheckUseGet <Int32>] [-Verify <Int16>] [-ExtraHdrKey <String>] [-ExtraHdrValue <String>] [-AllowedHosts <String>] 
[-AllowedDirectories <String>] [-AllowedGroups <String>] [-GroupSIDs <String>] [-IncludeNestedGroups <Boolean>] 
[-DisplayPubPriv <Boolean>] [-DisablePasswordForm <Boolean>] [-Domain <String>] [-AltDomains <String>] [-Logoff <String>] 
[-ESPLogs <Int16>] [-SMTPAllowedDomains <String>] [-ESPEnabled <Boolean>] [-UserPwdChangeUrl <String>] [-UserPwdChangeMsg 
<String>] [-InputAuthMode <Int16>] [-OutputAuthMode <Int16>] [-StartTLSMode <Int16>] [-ExtraPorts <String>] [-AltAddress 
<String>] [-MultiConnect <Boolean>] [-SingleSignOnDir <String>] [-OCSPVerify <String>] [-FollowVSID <Int32>] [-TlsType 
<Boolean>] [-CheckPostData <String>] [-CheckCodes <String>] [-PreProcPrecedence <String>] [-PreProcPrecedencePos <Int16>] 
[-RequestPrecedence <String>] [-RequestPrecedencePos <Int16>] [-ResponsePrecedence <String>] [-ResponsePrecedencePos 
<Int16>] [-RsRulePrecedence <String>] [-RsRulePrecedencePos <Int16>] [-NeedHostName <Boolean>] [-CopyHdrFrom <String>] 
[-CopyHdrTo <String>] [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN <String>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-VirtualService
                                        
										
										true
										false
										
									

									

										-VSPort
                                        
										
										true
										false
										
									

									

										-VSProtocol
                                        
										
										true
										false
										
									

									

										-AddVia
                                        
										
										false
										false
										
									

									

										-Template
                                        
										
										false
										false
										
									

									

										-Cache
                                        
										
										false
										false
										
									

									

										-CertFile
                                        
										
										false
										false
										
									

									

										-CheckType
                                        
										
										false
										false
										
									

									

										-CheckHost
                                        
										
										false
										false
										
									

									

										-CheckPattern
                                        
										
										false
										false
										
									

									

										-CheckUrl
                                        
										
										false
										false
										
									

									

										-CheckHeaders
                                        
										
										false
										false
										
									

									

										-LdapEndpoint
                                        
										
										false
										false
										
									

									

										-MatchLen
                                        
										
										false
										false
										
									

									

										-CheckUse1_1
                                        
										
										false
										false
										
									

									

										-CheckPort
                                        
										
										false
										false
										
									

									

										-EnhancedHealthChecks
                                        
										
										false
										false
										
									

									

										-RsMinimum
                                        
										
										false
										false
										
									

									

										-ClientCert
                                        
										
										false
										false
										
									

									

										-Compress
                                        
										
										false
										false
										
									

									

										-Cookie
                                        
										
										false
										false
										
									

									

										-CachePercent
                                        
										
										false
										false
										
									

									

										-DefaultGW
                                        
										
										false
										false
										
									

									

										-Enable
                                        
										
										false
										false
										
									

									

										-ErrorCode
                                        
										
										false
										false
										
									

									

										-ErrorUrl
                                        
										
										false
										false
										
									

									

										-PortFollow
                                        
										
										false
										false
										
									

									

										-ForceL7
                                        
										
										false
										false
										
									

									

										-Idletime
                                        
										
										false
										false
										
									

									

										-LocalBindAddresses
                                        
										
										false
										false
										
									

									

										-VSType
                                        
										
										false
										false
										
									

									

										-Nickname
                                        
										
										false
										false
										
									

									

										-Persist
                                        
										
										false
										false
										
									

									

										-PersistTimeout
                                        
										
										false
										false
										
									

									

										-QueryTag
                                        
										
										false
										false
										
									

									

										-CipherSet
                                        
										
										false
										false
										
									

									

										-SSLReencrypt
                                        
										
										false
										false
										
									

									

										-SSLReverse
                                        
										
										false
										false
										
									

									

										-SSLRewrite
                                        
										
										false
										false
										
									

									

										-ReverseSNIHostname
                                        
										
										false
										false
										
									

									

										-Schedule
                                        
										
										false
										false
										
									

									

										-ServerInit
                                        
										
										false
										false
										
									

									

										-SSLAcceleration
                                        
										
										false
										false
										
									

									

										-StandByAddr
                                        
										
										false
										false
										
									

									

										-StandByPort
                                        
										
										false
										false
										
									

									

										-TransactionLimit
                                        
										
										false
										false
										
									

									

										-Transparent
                                        
										
										false
										false
										
									

									

										-SubnetOriginating
                                        
										
										false
										false
										
									

									

										-UseforSnat
                                        
										
										false
										false
										
									

									

										-QoS
                                        
										
										false
										false
										
									

									

										-CheckUseGet
                                        
										
										false
										false
										
									

									

										-Verify
                                        
										
										false
										false
										
									

									

										-ExtraHdrKey
                                        
										
										false
										false
										
									

									

										-ExtraHdrValue
                                        
										
										false
										false
										
									

									

										-AllowedHosts
                                        
										
										false
										false
										
									

									

										-AllowedDirectories
                                        
										
										false
										false
										
									

									

										-AllowedGroups
                                        
										
										false
										false
										
									

									

										-GroupSIDs
                                        
										
										false
										false
										
									

									

										-IncludeNestedGroups
                                        
										
										false
										false
										
									

									

										-DisplayPubPriv
                                        
										
										false
										false
										
									

									

										-DisablePasswordForm
                                        
										
										false
										false
										
									

									

										-Domain
                                        
										
										false
										false
										
									

									

										-AltDomains
                                        
										
										false
										false
										
									

									

										-Logoff
                                        
										
										false
										false
										
									

									

										-ESPLogs
                                        
										
										false
										false
										
									

									

										-SMTPAllowedDomains
                                        
										
										false
										false
										
									

									

										-ESPEnabled
                                        
										
										false
										false
										
									

									

										-UserPwdChangeUrl
                                        
										
										false
										false
										
									

									

										-UserPwdChangeMsg
                                        
										
										false
										false
										
									

									

										-InputAuthMode
                                        
										
										false
										false
										
									

									

										-OutputAuthMode
                                        
										
										false
										false
										
									

									

										-StartTLSMode
                                        
										
										false
										false
										
									

									

										-ExtraPorts
                                        
										
										false
										false
										
									

									

										-AltAddress
                                        
										
										false
										false
										
									

									

										-MultiConnect
                                        
										
										false
										false
										
									

									

										-SingleSignOnDir
                                        
										
										false
										false
										
									

									

										-OCSPVerify
                                        
										
										false
										false
										
									

									

										-FollowVSID
                                        
										
										false
										false
										
									

									

										-TlsType
                                        
										
										false
										false
										
									

									

										-CheckPostData
                                        
										
										false
										false
										
									

									

										-CheckCodes
                                        
										
										false
										false
										
									

									

										-PreProcPrecedence
                                        
										
										false
										false
										
									

									

										-PreProcPrecedencePos
                                        
										
										false
										false
										
									

									

										-RequestPrecedence
                                        
										
										false
										false
										
									

									

										-RequestPrecedencePos
                                        
										
										false
										false
										
									

									

										-ResponsePrecedence
                                        
										
										false
										false
										
									

									

										-ResponsePrecedencePos
                                        
										
										false
										false
										
									

									

										-RsRulePrecedence
                                        
										
										false
										false
										
									

									

										-RsRulePrecedencePos
                                        
										
										false
										false
										
									

									

										-NeedHostName
                                        
										
										false
										false
										
									

									

										-CopyHdrFrom
                                        
										
										false
										false
										
									

									

										-CopyHdrTo
                                        
										
										false
										false
										
									

									

										-LoadBalancer
                                        
										
										false
										false
										
									

									

										-LBPort
                                        
										
										false
										false
										
									

									

										-Credential
                                        
										
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										
										false
										false
										
									

									

										-SubjectCN
                                        
										
										false
										false
										
									

								
							

						
				
				

				

					

						
 New-VSPacketFilterACL 

						
Adds an address to the black or white list for a Virtual Service.

						
Adds a host or network IP address to the black or white access control list for a specific Virtual Service. Note that black 
and white lists are only enabled when packet filtering is enabled.

					

                        

                        
 Syntax 

                        

						

                            


New-VSPacketFilterACL [-VirtualService <String>] [-VSPort <Int32>] [-VSProtocol <String>] [-VSIndex <Int32>] -Type <String> 
-AclAddress <String> [-AclComment <String>] [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

New-VSPacketFilterACL [-VirtualService <String>] [-VSPort <Int32>] [-VSProtocol <String>] [-VSIndex <Int32>] -Type <String> 
-AclAddress <String> [-AclComment <String>] [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] 
[-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-VirtualService
                                        
										Specifies the Virtual Service IP address.
										false
										false
										
									

									

										-VSPort
                                        
										Specifies the Virtual Service port number.
										false
										false
										
									

									

										-VSProtocol
                                        
										Specifies the Virtual Service protocol.
										false
										false
										
									

									

										-VSIndex
                                        
										The index number of the relevant Virtual Service. To retrieve the Virtual Service index, run the Get-AdcVirtualService 
command.		
										false
										false
										
									

									

										-Type
                                        
										Specify the type of list:
- black: blocked addresses
- white: allowed addresses
Note: This is case sensitive – the type value should be in lowercase.		
										true
										false
										
									

									

										-AclAddress
                                        
										Specifies a host or network IP address to add to the access control list. The address can be specified in CIDR format. If 
the CIDR is not specified, the system uses a default of /32.		
										true
										false
										
									

									

										-AclComment
                                        
										Optionally specify a comment in relation to the list entry.
										false
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

New-VSPacketFilterACL -AclAddress 10.134.33.2 -Type black -VirtualService 10.35.47.16 -VSPort 80 -VSProtocol tcp

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.

                            

						

                        
Top of page
				

				

					

						
 New-WafCustomRuleData 

						
Upload a custom rule data file.

						
This command allows you to upload a custom rule data file to the LoadMaster.

					

                        

                        
 Syntax 

                        

						

                            


New-WafCustomRuleData -Path <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

New-WafCustomRuleData -Path <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] 
[-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-Path
                                        
										The path where the custom rule data file is stored followed by a back slash and the filename/extension.
										true
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-Filename
                                        
										The filename of the custom rule data file followed by the file extension (.data).
										true
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

New-WafCustomRuleData -Filename modsecurity_35_bad_robots.data -Path C:\t\modsecurity_35_bad_robots.data

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.

                            

						

                        
Top of page
				

				

					

						
 New-WafCustomRuleSet 

						
Upload custom Web Application Firewall (WAF) rule files or a rule set.

						
Upload custom WAF rule files or a rule set to the LoadMaster.

					

                        

                        
 Syntax 

                        

						

                            


New-WafCustomRuleSet -Path <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

New-WafCustomRuleSet -Path <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] 
[-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-Path
                                        
										The path to the custom rule file(s) or rule set file followed by a forward slash and then the filename.extension.
										true
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-Filename
                                        
										The desired rule name to be displayed on the WUI. This is only relevant for individual rule files.
										true
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

New-WafCustomRuleSet -Filename modsecurity_crs_40_generic_attacks.conf -Path C:\WAF\modsecurity-crs_2.2.5\modsecurity-crs_2.2.5\base_rules\modsecurity_crs_40_generic_attacks.conf

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.

                            

						

                        
Top of page
				

				

					

						
 NMAddNode 

						
WARNING: This function is deprecated. Use the following command instead:
New-ClusterNode

						
WARNING: This function is deprecated. Use the following command instead:
New-ClusterNode

					

                        

                        
 Syntax 

                        

						

                            


NMAddNode -Address <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

NMAddNode -Address <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN 
<String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-Address
                                        
										
										true
										false
										
									

									

										-LoadBalancer
                                        
										
										false
										false
										
									

									

										-LBPort
                                        
										
										false
										false
										
									

									

										-Credential
                                        
										
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										
										false
										false
										
									

									

										-SubjectCN
                                        
										
										false
										false
										
									

								
							

						
				
				

				

					

						
 NMClusterCreate 

						
WARNING: This function is deprecated. Use the following command instead:
New-Cluster

						
WARNING: This function is deprecated. Use the following command instead:
New-Cluster

					

                        

                        
 Syntax 

                        

						

                            


NMClusterCreate -SharedAddress <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

NMClusterCreate -SharedAddress <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] 
[-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-SharedAddress
                                        
										
										true
										false
										
									

									

										-LoadBalancer
                                        
										
										false
										false
										
									

									

										-LBPort
                                        
										
										false
										false
										
									

									

										-Credential
                                        
										
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										
										false
										false
										
									

									

										-SubjectCN
                                        
										
										false
										false
										
									

								
							

						
				
				

				

					

						
 NMClusterStatus 

						
WARNING: This function is deprecated. Use the following command instead:
Get-ClusterStatus

						
WARNING: This function is deprecated. Use the following command instead:
Get-ClusterStatus

					

                        

                        
 Syntax 

                        

						

                            


NMClusterStatus [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction <ActionPreference>] 
[-InformationVariable <String>] [<CommonParameters>]

NMClusterStatus [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN <String>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-LoadBalancer
                                        
										
										false
										false
										
									

									

										-LBPort
                                        
										
										false
										false
										
									

									

										-Credential
                                        
										
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										
										false
										false
										
									

									

										-SubjectCN
                                        
										
										false
										false
										
									

								
							

						
				
				

				

					

						
 NMDeleteNode 

						
WARNING: This function is deprecated. Use the following command instead:
Remove-ClusterNode

						
WARNING: This function is deprecated. Use the following command instead:
Remove-ClusterNode

					

                        

                        
 Syntax 

                        

						

                            


NMDeleteNode -NodeId <Int32> [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

NMDeleteNode -NodeId <Int32> [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN 
<String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-NodeId
                                        
										
										true
										false
										
									

									

										-LoadBalancer
                                        
										
										false
										false
										
									

									

										-LBPort
                                        
										
										false
										false
										
									

									

										-Credential
                                        
										
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										
										false
										false
										
									

									

										-SubjectCN
                                        
										
										false
										false
										
									

								
							

						
				
				

				

					

						
 NMDisableNode 

						
WARNING: This function is deprecated. Use the following command instead:
Disable-ClusterNode

						
WARNING: This function is deprecated. Use the following command instead:
Disable-ClusterNode

					

                        

                        
 Syntax 

                        

						

                            


NMDisableNode -NodeId <Int32> [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

NMDisableNode -NodeId <Int32> [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN 
<String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-NodeId
                                        
										
										true
										false
										
									

									

										-LoadBalancer
                                        
										
										false
										false
										
									

									

										-LBPort
                                        
										
										false
										false
										
									

									

										-Credential
                                        
										
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										
										false
										false
										
									

									

										-SubjectCN
                                        
										
										false
										false
										
									

								
							

						
				
				

				

					

						
 NMEnableNode 

						
WARNING: This function is deprecated. Use the following command instead:
Enable-ClusterNode

						
WARNING: This function is deprecated. Use the following command instead:
Enable-ClusterNode

					

                        

                        
 Syntax 

                        

						

                            


NMEnableNode -NodeId <Int32> [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

NMEnableNode -NodeId <Int32> [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN 
<String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-NodeId
                                        
										
										true
										false
										
									

									

										-LoadBalancer
                                        
										
										false
										false
										
									

									

										-LBPort
                                        
										
										false
										false
										
									

									

										-Credential
                                        
										
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										
										false
										false
										
									

									

										-SubjectCN
                                        
										
										false
										false
										
									

								
							

						
				
				

				

					

						
 NMJoinCluster 

						
WARNING: This function is deprecated. Use the following command instead:
Join-Cluster

						
WARNING: This function is deprecated. Use the following command instead:
Join-Cluster

					

                        

                        
 Syntax 

                        

						

                            


NMJoinCluster [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction <ActionPreference>] 
[-InformationVariable <String>] [<CommonParameters>]

NMJoinCluster [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN <String>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-LoadBalancer
                                        
										
										false
										false
										
									

									

										-LBPort
                                        
										
										false
										false
										
									

									

										-Credential
                                        
										
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										
										false
										false
										
									

									

										-SubjectCN
                                        
										
										false
										false
										
									

								
							

						
				
				

				

					

						
 Ping-Host 

						
Ping the specified host.

						
The ping command displays whether the destination responded and how long it took to receive a reply. The destination can be 
an IP address or a Fully Qualified Domain Name (FQDN).

					

                        

                        
 Syntax 

                        

						

                            


Ping-Host -Address <String> [-PingClass <String>] [-Interface <String>] [-LoadBalancer <String>] [-LBPort <Int32>] 
[-Credential <Object>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Ping-Host -Address <String> [-PingClass <String>] [-Interface <String>] [-LoadBalancer <String>] [-LBPort <Int32>] 
[-CertificateStoreLocation <String>] [-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable 
<String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-Address
                                        
										The destination address to ping. The destination can be an IP address or a FQDN.
										true
										false
										
									

									

										-PingClass
                                        
										Specify ping for IPv4 addresses or ping6 for IPv6 addresses.
										false
										false
										
									

									

										-Interface
                                        
										Specify the ID of the interface from which the ping should be sent from. If the interface is not specified here, the 
correct interface to ping an address on a particular network will be automatically selected.		
										false
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Ping-Host -Address 10.154.190.207 -PingClass ping

							    
Example Output:
Full response: @{ReturnCode=422; Response=Command Failed; Data=}
Return Code..: 422
Response.....: Command Failed
Data field...: @{PingResult=Command Failed: PING 10.35.47.8 (10.35.47.8) 56(84) bytes of data. From 10.35.47.15 icmp_seq=1 
Destination Host Unreachable 
From 10.35.47.15 icmp_seq=2 Destination Host Unreachable From 10.35.47.15 icmp_seq=3 Destination Host Unreachable; 
PacketsTransmitted=3 packets transmit
ted; PacketsReceived=0 received; Errors=+3 errors; PacketsLoss=100% packet loss; Time=}

                            

						

                        
Top of page
				

				

					

						
 Read-LicenseEULA 

						
Displays the EULA and a magic cookie.

						
The End User License Agreement (EULA) and magic cookie will be displayed.

					

                        

                        
 Syntax 

                        

						

                            


Read-LicenseEULA [[-LoadBalancer] <String>] [[-LBPort] <Int32>] [[-Credential] <Object>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

$read = Read-LicenseEULA

							    
Example Output:
Full response: @{MagicString=013b50b2-e3bb-468e-b64a-de78d46cdfb8; Eula=...  
Return Code..: 200
Response.....: Command successfully executed
Data field...:
Eula                                                                                                                        
                                                                   
----                                                                                                                        
                                                                   
@{MagicString=013b50b2-e3bb-468e-b64a-de78d46cdfb8; Eula=... 
Param........:
<p style="text-align:center"><h2>LoadMaster End User License Agreement</h2></p>

<p style="text-align:center">Kemp Technologies END-USER PRODUCT LICENSE AGREEMENT</p>

<p>
1. READ THE FOLLOWING TERMS AND CONDITIONS CAREFULLY BEFORE INSTALLING THIS PRODUCT ON YOUR NETWORK OR PERSONAL COMPUTER. 
THIS PRODUCT LICENSE AGREEMENT IS A LEGAL AGREEMENT BETWEEN YOU (EITHE
R ON BEHALF OF YOURSELF AS AN INDIVIDUAL OR ON BEHALF OF AN ENTITY AS ITS AUTHORIZED REPRESENTATIVE) ON THE ONE HAND, AND 
Kemp Technologies, INC. AND ITS SUBSIDIARIES AND AFFILIATES (COLLECTIV
ELY REFERRED TO AS 'Kemp') ON THE OTHER HAND, FOR THE HARDWARE AND/OR SOFTWARE PRODUCT ENTITLED 'LoadMaster,' WHICH 
INCLUDES PHYSICAL HARDWARE AND/OR COMPUTER SOFTWARE AND ANY ASSOCIATED MEDIA
, PRINTED MATERIALS, AND/OR 'ONLINE' OR ELECTRONIC DOCUMENTATION (TOGETHER CALLED THE 'PRODUCT'). PLEASE READ THIS 
AGREEMENT CAREFULLY AND PRINT OUT A COPY FOR YOUR RECORDS. THIS AGREEMENT SUP
ERSEDES PREVIOUS VERSIONS.</p>

<br />

<p>BY INSTALLING, COPYING, OR OTHERWISE USING THE PRODUCT, YOU ACKNOWLEDGE THAT YOU HAVE READ THIS PRODUCT LICENSE 
AGREEMENT AND AGREE TO BE BOUND BY ITS TERMS. THE PRODUCT IS LICENSED, NOT SO
LD, TO YOU FOR USE ONLY UNDER THE TERMS OF THIS AGREEMENT. IF YOU DO NOT AGREE TO THE TERMS OF THIS PRODUCT LICENSE 
AGREEMENT, DO NOT INSTALL OR USE THE PRODUCT AND DELETE ALL COPIES IN YOUR P
OSSESSION. </p>

<br />

<p>2. Kemp grants you a non-exclusive, non-transferable license to use one copy of the Product in the country in which you 
acquired the Product for your own personal or commercial use, but ret
ains all property rights in the Product and all copies thereof. All other rights are expressly reserved by Kemp. You may: 
(i) use the Product on any supported computer configuration, provided 
the Product is used on only one (1) such computer; and (ii) permanently transfer the Product and its documentation to 
another user provided you retain no copies and the recipient agrees to the
 terms of this Agreement. You may not transfer, distribute, rent, sub-license, or lease the Product or documentation, 
except as provided herein; or alter, modify, or adapt the Product or docum
entation, or any portions thereof.</p>

<br />

<p>3. You acknowledge that the Product in source code form remains a confidential trade secret of Kemp. You agree not to 
modify or attempt to reverse engineer, decompile, or disassemble the Pr
oduct, except and only to the extent that such activity is expressly permitted by applicable law notwithstanding this 
limitation.</p>

<br />

<p>4. OWNERSHIP: All right, title and interest and intellectual property rights in and to the Product (including but not 
limited to any titles, computer code, concepts, screen images, text and
 'applets,' incorporated into the Product), the accompanying printed materials, and any copies of the Software, are owned 
by Kemp or its licensors. This Agreement grants you no rights to use s
uch content other than as part of the Product.</p>

<br />

<p>5. This Agreement is effective upon your installation of the Product and shall continue until revoked by Kemp or until 
you breach any term hereof; upon termination you agree to destroy and/
or delete all copies of the Product in your possession. </p>

<br />

<p>6. LICENSE RESTRICTIONS: You acknowledge that the foregoing license extends only to your use of the features and 
functionality of the Product as described in the documentation accompanying 
the version of the Software downloaded or Product obtained by you (the "Documentation"), and you agree not to reconfigure 
or modify the Product in order to enable features or functionality dif
ferent than those described in such Documentation or available in other Kemp products without notifying Kemp and paying the 
applicable Product upgrade fee. You may not: (i) reverse engineer, d
ecompile, or disassemble the Product; (ii) modify, or create derivative works based upon, the Product in whole or in part; 
(iii) distribute copies of the Product; (iv) remove any proprietary n
otices or labels on the Product; or (v) resell, lease, rent, transfer, sublicense, or otherwise transfer rights to the 
Product. Any use in violation of this Section shall immediately terminate
 your license to the Product.</p>

<br />

<p>7. TITLE: You agree that no title to the intellectual property in the Product, Subscription Services (as defined), or 
license keys is transferred to you. Title, ownership, rights, and intel
lectual property rights in and to the Product, Subscription Services, and license keys shall remain in Kemp and/or Kemp's 
licensors. The Product, Subscription Services and license keys are pro
tected by intellectual property laws of the United States and other countries and by international treaties.</p>

<br />

<p>8. GENERAL: The Product is provided to you at minimal charge. Kemp does not guarantee that use of the Product will be 
uninterrupted or error-free. You acknowledge that performance of the Pr
oduct may be affected by any number of factors, including without limitation, technical failure of the Product, the acts or 
omissions of third parties and other causes reasonably beyond the co
ntrol of Kemp. Certain features of the Product may not be forward-compatible with future versions of the Product and use of 
such features with future versions of the Product may require purcha
se of the applicable future version of the Product.</p>

<br />

<p>9. AS IS SALE: YOU AGREE THAT Kemp AND ITS LICENSORS HAVE MADE NO EXPRESS WARRANTIES, ORAL OR WRITTEN, TO YOU REGARDING 
THE PRODUCT AND THAT THE PRODUCT IS BEING PROVIDED TO YOU "AS IS" WIT
HOUT WARRANTY OF ANY KIND. YOU ACKNOWLEDGE THAT THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PRODUCT IS WITH 
YOU. SHOULD THE PRODUCT PROVE DEFECTIVE, YOU (AND NOT Kemp, THE RETAILE
R, OR ANY DISTRIBUTOR) ASSUME THE ENTIRE COST OF ALL NECESSARY REPAIRS.</p>

<br />

<p>10. DISCLAIMER: Kemp DISCLAIMS ANY AND ALL OTHER WARRANTIES, WHETHER EXPRESS, IMPLIED, OR STATUTORY, INCLUDING, BUT 
WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF NONINFRINGEMENT OF THIRD PA
RTY RIGHTS, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. THIS WARRANTY DISCLAIMER AFFECTS YOUR LEGAL RIGHTS, AND 
YOU MAY ALSO HAVE OTHER RIGHTS WHICH VARY FROM JURISDICTION TO JURISDIC
TION. SOME JURISDICTIONS DO NOT ALLOW EXCLUSIONS OF IMPLIED WARRANTIES OR LIMITATIONS ON HOW LONG AN IMPLIED WARRANTY 
LASTS, SO THE ABOVE EXCLUSION MAY NOT APPLY TO YOU.</p>

<br />

<p>11. Limitation on Liability. EXCEPT FOR BODILY INJURY OF A PERSON, IN NO EVENT WILL Kemp BE LIABLE TO YOU OR ANY THIRD 
PARTY FOR ANY DAMAGES ARISING OUT OF THE SUBJECT MATTER OF THIS AGREEM
ENT, THE PRODUCT OR ANY SERVICES UNDER ANY CONTRACT, NEGLIGENCE, STRICT LIABILITY OR OTHER THEORY, FOR ANY INDIRECT, 
SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES (INCLUDING LOST PROFITS), OR 
FOR LOSS OF OR CORRUPTION OF DATA, OR FOR COST OF PROCUREMENT OF SUBSTITUTE GOODS OR TECHNOLOGY, IRRESPECTIVE OF WHETHER 
Kemp HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. Kemp'S MAXIMU
M LIABILITY FOR DAMAGES SHALL BE LIMITED TO THE LICENSE FEES RECEIVED BY Kemp UNDER THIS LICENSE FOR THE PARTICULAR 
PRODUCT(S) WHICH CAUSED THE DAMAGES. Some jurisdictions do not allow the exc
lusion or limitation of incidental or consequential damages, so the above limitation or exclusion may not apply to You.</p>

<br />

<p>12. TERMINATION: This Agreement shall terminate automatically if you fail to comply with the terms of this Agreement. No 
notice shall be required from Kemp to effect such termination. You m
ay also terminate this Agreement at any time by notifying Kemp in writing of termination. Upon any termination of this 
Agreement, you must uninstall and destroy all copies of the Product.</p>

<br />

<p>13. MISCELLANEOUS:</p>

<p>13.1 COMPLIANCE WITH EXPORT CONTROL LAWS: End User agrees to comply fully with all relevant export laws and regulations, 
including but not limited to the U.S. Export Administration Regulati
ons and regulations promulgated by the U.S. Department of the Treasury's Office of Foreign Assets Control ("OFAC"), as 
amended from time to time (collectively, the "Export Control Laws"). End 
User agrees not to export or reexport the Product to any parties located in any E:1countries which are specifically 
prohibited under U.S. embargoes or sanctions programs maintained by the OFAC
 or otherwise prohibited under the Export Control Laws.   The current list of E:1 Countries is available at the following 
link http://www.bis.doc.gov/index.php/forms-documents/doc_view/452-sup
plement-no-1-to-part-740-country-groups</p>

<br />

<p>13.2 U.S. GOVERNMENT RIGHTS: The Product under this Agreement is commercial computer product as that term is described 
in 48 C.F.R. 252.227-7014(a)(1). If acquired by or on behalf of a civi
lian agency, the U.S. Government acquires this commercial computer product and/or commercial computer product documentation 
subject to the terms of this Agreement as specified in 48 C.F.R. 12.
212 (Computer Product) and 12.211 (Technical Data) of the Federal Acquisition Regulations ("FAR") and its successors. If 
acquired by or on behalf of any agency within the Department of Defense
 ("DOD"), the U.S. Government acquires this commercial computer product and/or commercial computer product documentation 
subject to the terms of this Agreement as specified in 48 C.F.R. 227.72
02-3 of the DOD FAR Supplement ("DFAR") and its successors.</p>

<br />

<p>13.3 GOVERNING LAW: This Agreement will be governed by the laws of the State of New York as they are applied to 
agreements between New York residents entered into and to be performed entire
ly within New York. The United Nations Convention on Contracts for the International Sale of Goods is specifically 
disclaimed.</p>

<br />

<p>13.4 ENTIRE AGREEMENT: You agree that this is the entire agreement between you and Kemp, and that it supersedes any 
prior agreement, whether written or oral, and all other communications be
tween Kemp and you relating to the subject matter of this Agreement. This Agreement may be amended, modified or 
supplemented only by a writing that is signed by the authorized representatives 
of both parties.</p>

<br />

<p>13.5 RESERVATION OF RIGHTS: All rights not expressly granted in this Agreement are reserved by Kemp.</p>

<br />

<p>14. INJUNCTION. Because Kemp would be irreparably damaged if the terms of this License Agreement were not specifically 
enforced, you agree that Kemp shall be entitled, without bond, other s
ecurity or proof of damages, to appropriate equitable remedies with respect to breaches of this Agreement, in addition to 
such other remedies as Kemp may otherwise have under applicable laws.<
/p>

<br />

<p>15. INDEMNITY. At Kemp's request, you agree to defend, indemnify and hold harmless Kemp, its subsidiaries, affiliates, 
contractors, officers, directors, employees, agents, licensors, licens
ees, distributors, developers, content providers, and other users of the Product, from all damages, losses, liabilities, 
claims and expenses, including attorneys' fees, arising directly or ind
irectly from your acts and omissions to act in using the Product pursuant to the terms of this License Agreement or any 
breach of this License Agreement by you. Kemp reserves the right, at its
 own expense, to assume the exclusive defense and control of any matter otherwise subject to indemnification by you 
hereunder, and in such event, you shall have no further obligation to provid
e indemnification for such matter. </p>

<br />

<p>16. TERMINATION. Without prejudice to any other rights of Kemp, this License Agreement and your right to use the Product 
may automatically terminate without notice from Kemp if you fail to 
comply with any provision of this Agreement or any terms and conditions associated with the Product. In such event, you 
must destroy all copies of this Product and all of its component parts.<
/p>

<br />

<p>17. GENERAL PROVISIONS. You may not use, copy, modify, sublicense, rent, sell, assign or transfer the rights or 
obligations granted to you in this Agreement, except as expressly provided in
 this Agreement. Any assignment in violation of this Agreement is void, except that you may transfer your Product to 
another person provided that person accepts the terms of this License Agree
ment. If any provision of this Agreement is held to be unenforceable for any reason, such provision shall be reformed only 
to the extent necessary to make it enforceable, and such decision sha
ll not affect the enforceability of: (i) such provision under other circumstances, or (ii) the remaining provisions hereof 
under all circumstances. Kemp's failure to enforce at any time any of
 the provisions of this Agreement shall in no way be construed to be a present or future waiver of such provisions, nor in 
any way affect the right of any party to enforce each and every such 
provision thereafter. The express waiver by Kemp of any provision, condition or requirement of this Agreement shall not 
constitute a waiver of any future obligation to comply with such provisi
on, condition or requirement. Notwithstanding anything else in this Agreement, no default, delay or failure to perform on 
the part of Kemp shall be considered a breach of this Agreement if suc
h default, delay or failure to perform is shown to be due to causes beyond the reasonable control of Kemp. This Agreement 
represents the complete agreement concerning this License Agreement be
tween you and Kemp. </p>

<br />
<p>Copyright (c) 2002-2017 Kemp Technologies, Inc.</p>


<p style="text-align:center">
If you do not agree with terms put forth above contact your Kemp Representative for further information and help.
</p>

                            

						

                        
Top of page
				

				

					

						
 Register-BondedInterface 

						
WARNING: This function is deprecated. Use the following command instead:
Register-NetworkBondedInterface

						
WARNING: This function is deprecated. Use the following command instead:
Register-NetworkBondedInterface

					

                        

                        
 Syntax 

                        

						

                            


Register-BondedInterface -InterfaceID <Int16> [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Register-BondedInterface -InterfaceID <Int16> [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation 
<String>] [-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-InterfaceID
                                        
										
										true
										false
										
									

									

										-LoadBalancer
                                        
										
										false
										false
										
									

									

										-LBPort
                                        
										
										false
										false
										
									

									

										-Credential
                                        
										
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										
										false
										false
										
									

									

										-SubjectCN
                                        
										
										false
										false
										
									

								
							

						
				
				

				

					

						
 Register-NetworkBondedInterface 

						
Enables you to register the address of a bonded interface.

						
This command waits two minutes to reconnect to the LoadMaster. If the wait time is longer than two minutes, an error 
message appears.

					

                        

                        
 Syntax 

                        

						

                            


Register-NetworkBondedInterface -InterfaceID <Int16> [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Register-NetworkBondedInterface -InterfaceID <Int16> [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation 
<String>] [-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-InterfaceID
                                        
										The interface ID that you are registering to the bonded interface. To view the interface ID for each of the interfaces, run 
the Get-Statistics command. The interface ID is the first number displayed in each interface row.		
										true
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Register-NetworkBondedInterface  -InterfaceID 0

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.
Data field...: @{Interface=}
Id                  : 0
IPAddress           : 10.154.11.180/16
Mtu                 : 1400
AdditionalAddresses : @{IPaddress=10.154.11.22/16}
NBondMembers        : 1
BondMembers         : @{RealInterface=0}
Mode                : 802.3ad
InterfaceType       : Bonded
GeoTrafficEnable    : yes
DefaultInterface    : yes

                            

						

                        
Top of page
				

				

					

						
 Remove-AdcContentRule 

						
Allows you to remove a specified rule from the LoadMaster.

						
Allows you to remove a specified rule from the LoadMaster.

					

                        

                        
 Syntax 

                        

						

                            


Remove-AdcContentRule -RuleName <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-Force 
<SwitchParameter>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [-WhatIf <SwitchParameter>] 
[-Confirm <SwitchParameter>] [<CommonParameters>]

Remove-AdcContentRule -RuleName <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] 
[-SubjectCN <String>] [-Force <SwitchParameter>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] 
[-WhatIf <SwitchParameter>] [-Confirm <SwitchParameter>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-RuleName
                                        
										The name of the content rule to remove.
										true
										true (ByValue)
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-Force
                                        
										Enable this parameter to force the command to execute without a confirmation.
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-WhatIf
                                        wi
										Enable this parameter to see what the command will do without actually executing the command.
										false
										false
										
									

									

										-Confirm
                                        cf
										Confirms that the action should be carried out.
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-Name
                                        
										The name of the rule. This parameter is required.
										true
										true (ByValue)
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Remove-AdcContentRule -Name TestRule2 -Confirm

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.

                            

						

                        
Top of page
				

				

					

						
 Remove-AdcHttpCacheException 

						
Allows you to remove an extension from the 'Do Not Cache' extension list.

						
Allows you to remove an extension from the 'Do Not Cache' extension list.

					

                        

                        
 Syntax 

                        

						

                            


Remove-AdcHttpCacheException -Extension <String[]> [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Remove-AdcHttpCacheException -Extension <String[]> [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation 
<String>] [-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-Extension
                                        
										The file extension that should be removed from the "no cache" list. The extension must start with "." For example: ".jpg" 
This parameter is required.		
										true
										true (ByValue)
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Remove-AdcHttpCacheException -Extension .mp4

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.

                            

						

                        
Top of page
				

				

					

						
 Remove-AdcHttpCompressionException 

						
Allows you to remove an extension from the 'Do Not Compress' extension list.

						
Allows you to remove an extension from the 'Do Not Compress' extension list.

					

                        

                        
 Syntax 

                        

						

                            


Remove-AdcHttpCompressionException -Extension <String[]> [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Remove-AdcHttpCompressionException -Extension <String[]> [-LoadBalancer <String>] [-LBPort <Int32>] 
[-CertificateStoreLocation <String>] [-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable 
<String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-Extension
                                        
										The file extension that should be removed from the "no compress" list. The extension must start with "." For example: 
".jpg" This parameter is required.		
										true
										true (ByValue)
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Remove-AdcHttpCompressionException -Extension .mp4

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.

                            

						

                        
Top of page
				

				

					

						
 Remove-AdcRealServer 

						
Allows you to remove a Real Server from a Virtual Service.

						
Allows you to remove a Real Server from a Virtual Service.

					

                        

                        
 Syntax 

                        

						

                            


Remove-AdcRealServer [-VirtualService <String>] [-VSPort <Int32>] [-VSProtocol <String>] [-VSIndex <Int32>] [-RealServer 
<String>] [-RealServerPort <Int32>] [-RSIndex <Int32>] [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] 
[-Force <SwitchParameter>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [-WhatIf 
<SwitchParameter>] [-Confirm <SwitchParameter>] [<CommonParameters>]

Remove-AdcRealServer [-VirtualService <String>] [-VSPort <Int32>] [-VSProtocol <String>] [-VSIndex <Int32>] [-RealServer 
<String>] [-RealServerPort <Int32>] [-RSIndex <Int32>] [-LoadBalancer <String>] [-LBPort <Int32>] 
[-CertificateStoreLocation <String>] [-SubjectCN <String>] [-Force <SwitchParameter>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [-WhatIf <SwitchParameter>] [-Confirm <SwitchParameter>] 
[<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-VirtualService
                                        
										The IP Address of the Virtual Service that connects to this Real Server.
										false
										false
										
									

									

										-VSPort
                                        
										The port of the Virtual Service to remove.
										false
										false
										
									

									

										-VSProtocol
                                        
										The protocol of the Virtual Service to remove.
										false
										false
										
									

									

										-VSIndex
                                        
										The index number of the relevant Virtual Service or SubVS. To retrieve the VSIndex, run the Get-VirtualService command.
										false
										false
										
									

									

										-RealServer
                                        
										The Real Server IP Address that is a backend server for the Virtual Service.
										false
										false
										
									

									

										-RealServerPort
                                        
										The port on which the Real Server accepts connections for this service.
										false
										false
										
									

									

										-RSIndex
                                        
										The index number of the Real Server to be removed. To retrieve the Real Server index, run the Get-VirtualService command.
										false
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-Force
                                        
										Enable this parameter to force the command to execute without a confirmation.
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-WhatIf
                                        wi
										Provides a method to see what the command will do without actually executing the command.
										false
										false
										
									

									

										-Confirm
                                        cf
										Confirms that the action should be carried out.
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-Port
                                        
										The port on which the Virtual Service accepts connections.
										false
										false
										
									

									

										-Protocol
                                        
										The protocol for communication. Accepts either TCP or UDP.
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Remove-AdcRealServer -Force -Port 80 -Protocol tcp -RealServer 10.11.0.24 -RealServerPort 80 -VirtualService 10.11.0.199

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.

                            

						

                        
Top of page
				

				

					

						
 Remove-AdcRealServerRule 

						
Allows you to remove a rule from the Real Server.

						
Allows you to remove a rule from the Real Server.

					

                        

                        
 Syntax 

                        

						

                            


Remove-AdcRealServerRule [-VirtualService <String>] [-VSPort <Int32>] [-VSProtocol <String>] [-VSIndex <Int32>] 
[-RealServer <String>] [-RSPort <Int32>] [-RSIndex <Int32>] -RuleName <String> [-LoadBalancer <String>] [-LBPort <Int32>] 
[-Credential <Object>] [-Force <SwitchParameter>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] 
[-WhatIf <SwitchParameter>] [-Confirm <SwitchParameter>] [<CommonParameters>]

Remove-AdcRealServerRule [-VirtualService <String>] [-VSPort <Int32>] [-VSProtocol <String>] [-VSIndex <Int32>] 
[-RealServer <String>] [-RSPort <Int32>] [-RSIndex <Int32>] -RuleName <String> [-LoadBalancer <String>] [-LBPort <Int32>] 
[-CertificateStoreLocation <String>] [-SubjectCN <String>] [-Force <SwitchParameter>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [-WhatIf <SwitchParameter>] [-Confirm <SwitchParameter>] 
[<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-VirtualService
                                        
										The IP Address of the Virtual Service this rule should be applied to.
										false
										false
										
									

									

										-VSPort
                                        
										The port of the relevant Virtual Service.
										false
										false
										
									

									

										-VSProtocol
                                        
										The protocol of the relevant Virtual Service.
										false
										false
										
									

									

										-VSIndex
                                        
										The index number of the relevant Virtual Service or SubVS. To retrieve the VSIndex, run the Get-VirtualService command.
										false
										false
										
									

									

										-RealServer
                                        
										The IP address of the relevant Real Server.
										false
										false
										
									

									

										-RSPort
                                        
										The port number of the relevant Real Server.
										false
										false
										
									

									

										-RSIndex
                                        
										The index number of the Real Server or SubVS to remove the rule from. To retrieve the Real Server index, run the 
Get-VirtualService command.		
										false
										false
										
									

									

										-RuleName
                                        
										The name of the rule that should be applied to the Virtual Service.
										true
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-Force
                                        
										Switch to force the command to execute without a confirmation.
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-WhatIf
                                        wi
										Provides a method to see what the command will do without actually executing the command.
										false
										false
										
									

									

										-Confirm
                                        cf
										Confirms that the action should be carried out.
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-Port
                                        
										The port on which this Virtual Service accepts connections.
										false
										false
										
									

									

										-Protocol
                                        
										The protocol for communication. Accepts either TCP or UDP.
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Remove-AdcRealServerRule -Port 80 -Protocol tcp -RealServer 10.11.0.24 -RSPort 80 -RuleName TestRule1 -VirtualService 10.11.0.200

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.

                            

						

                        
Top of page
				

				

					

						
 Remove-AdcSubVirtualService 

						
Remove a SubVS.

						
This command removes the specified SubVS.

					

                        

                        
 Syntax 

                        

						

                            


Remove-AdcSubVirtualService -SubVSIndex <Int32> [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-Force 
<SwitchParameter>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [-WhatIf <SwitchParameter>] 
[-Confirm <SwitchParameter>] [<CommonParameters>]

Remove-AdcSubVirtualService -SubVSIndex <Int32> [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation 
<String>] [-SubjectCN <String>] [-Force <SwitchParameter>] [-InformationAction <ActionPreference>] [-InformationVariable 
<String>] [-WhatIf <SwitchParameter>] [-Confirm <SwitchParameter>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-SubVSIndex
                                        
										The index number of the SubVS to delete.
										true
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-Force
                                        
										Switch to force the command to execute without a confirmation.
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-WhatIf
                                        wi
										Provides a method to see what the command will do without actually executing the command.
										false
										false
										
									

									

										-Confirm
                                        cf
										Confirms that the action should be carried out.
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Remove-AdcSubVirtualService -SubVSIndex 2

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.

                            

						

                        
Top of page
				

				

					

						
 Remove-AdcVirtualServerRule 

						
WARNING: This function is deprecated. Use the following command instead:
Remove-AdcVirtualServiceRule

						
WARNING: This function is deprecated. Use the following command instead:
Remove-AdcVirtualServiceRule

					

                        

                        
 Syntax 

                        

						

                            


Remove-AdcVirtualServerRule [-VirtualService <String>] [-VSPort <Int32>] [-VSProtocol <String>] [-VSIndex <Int32>] 
-RuleType <String> -RuleName <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-Force 
<SwitchParameter>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [-WhatIf <SwitchParameter>] 
[-Confirm <SwitchParameter>] [<CommonParameters>]

Remove-AdcVirtualServerRule [-VirtualService <String>] [-VSPort <Int32>] [-VSProtocol <String>] [-VSIndex <Int32>] 
-RuleType <String> -RuleName <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] 
[-SubjectCN <String>] [-Force <SwitchParameter>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] 
[-WhatIf <SwitchParameter>] [-Confirm <SwitchParameter>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-VirtualService
                                        
										Specifies the IP Address of the Virtual Service that this rule should be applied to.
										false
										false
										
									

									

										-VSPort
                                        
										
										false
										false
										
									

									

										-VSProtocol
                                        
										
										false
										false
										
									

									

										-VSIndex
                                        
										The index number of the relevant Virtual Service or SubVS. To retrieve the Virtual Service index, run the 
Get-VirtualService command.		
										false
										false
										
									

									

										-RuleType
                                        
										Specifies if the rule is a pre-processing rule, a response rule, or a request rule. Valid options are "pre", "response", 
and "request".		
										true
										false
										
									

									

										-RuleName
                                        
										The name of the rule that should be set on this Virtual Service.
										true
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-Force
                                        
										Switch to force the command to execute without a confirmation.
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-WhatIf
                                        wi
										Provides a method to see what the command will do without actually executing the command.
										false
										false
										
									

									

										-Confirm
                                        cf
										Confirms that the action should be carried out.
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-Port
                                        
										Specifies the port on which the Virtual Service accepts connections.
										false
										false
										
									

									

										-Protocol
                                        
										Specifies the communication protocol. Valid options are TCP or UDP.
										false
										false
										
									

									

										-RealServer
                                        
										Specifies the Real Server that serves this Virtual Service.
										false
										false
										
									

									

										-RSPort
                                        
										Specifies the port on which the Real Server accepts connections for this Virtual Service.
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Remove-AdcVirtualServerRule -RuleName ExampleRule -RuleType pre -VSIndex 2

							    
Example Output:
ok

                            

						

                        
Top of page
				

				

					

						
 Remove-AdcVirtualService 

						
Deletes the specified Virtual Service.

						
Deletes the specified Virtual Service.

					

                        

                        
 Syntax 

                        

						

                            


Remove-AdcVirtualService [-VirtualService <String>] [-VSPort <Int32>] [-VSProtocol <String>] [-VSIndex <Int32>] 
[-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-Force <SwitchParameter>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [-WhatIf <SwitchParameter>] [-Confirm <SwitchParameter>] 
[<CommonParameters>]

Remove-AdcVirtualService [-VirtualService <String>] [-VSPort <Int32>] [-VSProtocol <String>] [-VSIndex <Int32>] 
[-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN <String>] [-Force 
<SwitchParameter>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [-WhatIf <SwitchParameter>] 
[-Confirm <SwitchParameter>] [<CommonParameters>]

Remove-AdcVirtualService [-VirtualService <String>] [-VSPort <Int32>] [-VSProtocol <String>] [-LoadBalancer <String>] 
[-LBPort <Int32>] [-Force <SwitchParameter>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] 
[-WhatIf <SwitchParameter>] [-Confirm <SwitchParameter>] [<CommonParameters>]

Remove-AdcVirtualService [-VSIndex <Int32>] [-LoadBalancer <String>] [-LBPort <Int32>] [-Force <SwitchParameter>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [-WhatIf <SwitchParameter>] [-Confirm 
<SwitchParameter>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-VirtualService
                                        
										The IP Address for this Virtual Service.
										false
										false
										
									

									

										-VSPort
                                        
										The port of the Virtual Service to remove.
										false
										false
										
									

									

										-VSProtocol
                                        
										The protocol of the Virtual Service to remove.
										false
										false
										
									

									

										-VSIndex
                                        
										The index (ID) number for this Virtual Service. This can be retrieved by running the Get-AdcVirtualService command, or by 
checking the Id number on the Virtual Service modify screen.		
										false
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-Force
                                        
										Switch to force the command to execute without a confirmation.
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-WhatIf
                                        wi
										Provides a method to see what the command will do without actually executing the command.
										false
										false
										
									

									

										-Confirm
                                        cf
										Confirms that the action should be carried out.
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-Port
                                        
										Specifies the port on which this Virtual Service accepts connections.
										false
										false
										
									

									

										-Protocol
                                        
										Specifies the communication protocol. Valid options are TCP or UDP.
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Remove-AdcVirtualService -Port 80 -Protocol tcp -VirtualService 10.11.0.234

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.

                            

						

                        
Top of page
				

				

					

						
 Remove-AdcVirtualServiceResponseBodyRule 

						
Remove a response body modification rule from the specified Virtual Service.

						
Use this command to remove an existing response body modification rule from an existing Virtual Service.

					

                        

                        
 Syntax 

                        

						

                            


Remove-AdcVirtualServiceResponseBodyRule -VSIndex <Int32> -RuleName <String> [-LoadBalancer <String>] [-LBPort <Int32>] 
[-Credential <Object>] [-Force <SwitchParameter>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] 
[-WhatIf <SwitchParameter>] [-Confirm <SwitchParameter>] [<CommonParameters>]

Remove-AdcVirtualServiceResponseBodyRule -VSIndex <Int32> -RuleName <String> [-LoadBalancer <String>] [-LBPort <Int32>] 
[-CertificateStoreLocation <String>] [-SubjectCN <String>] [-Force <SwitchParameter>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [-WhatIf <SwitchParameter>] [-Confirm <SwitchParameter>] 
[<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-VSIndex
                                        
										The index number of the Virtual Service to remove the content rule from.
										true
										false
										
									

									

										-RuleName
                                        
										The name of the response body modification rule to remove from the Virtual Service.
										true
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-Force
                                        
										Switch to force the command to execute without a confirmation.
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-WhatIf
                                        wi
										Provides a method to see what the command will do without actually executing the command.
										false
										false
										
									

									

										-Confirm
                                        cf
										Because this command removes a rule from the specified Virtual Service, when you run the command you are asked if you are 
sure you want to perform this action. Enabling the Confirm parameter confirms that the action should be carried out, so you 
are not prompted to confirm after running the command.		
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Remove-AdcVirtualServiceResponseBodyRule -RuleName TestResponseBody -VSIndex 6 -Confirm -Force

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.

                            

						

                        
Top of page
				

				

					

						
 Remove-AdcVirtualServiceRule 

						
Remove a content rule that is assigned to a Virtual Service.

						
This command removes the specified rule from the specified Virtual Service.

					

                        

                        
 Syntax 

                        

						

                            


Remove-AdcVirtualServiceRule [-VirtualService <String>] [-VSPort <Int32>] [-VSProtocol <String>] [-VSIndex <Int32>] 
-RuleType <String> -RuleName <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-Force 
<SwitchParameter>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [-WhatIf <SwitchParameter>] 
[-Confirm <SwitchParameter>] [<CommonParameters>]

Remove-AdcVirtualServiceRule [-VirtualService <String>] [-VSPort <Int32>] [-VSProtocol <String>] [-VSIndex <Int32>] 
-RuleType <String> -RuleName <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] 
[-SubjectCN <String>] [-Force <SwitchParameter>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] 
[-WhatIf <SwitchParameter>] [-Confirm <SwitchParameter>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-VirtualService
                                        
										The address of the Virtual Service to remove the rule from.
										false
										false
										
									

									

										-VSPort
                                        
										The port number of the Virtual Service to remove the rule from.
										false
										false
										
									

									

										-VSProtocol
                                        
										The protocol of the Virtual Service to remove the rule from.
										false
										false
										
									

									

										-VSIndex
                                        
										The index number of the Virtual Service to remove the rule from.
										false
										false
										
									

									

										-RuleType
                                        
										The type of rule to be removed:
pre
response
request		
										true
										false
										
									

									

										-RuleName
                                        
										The name of the rule to be removed.
										true
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-Force
                                        
										Enable this parameter to force the command to execute without a confirmation.
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-WhatIf
                                        wi
										Enable this parameter to see what the command will do without actually executing the command.
										false
										false
										
									

									

										-Confirm
                                        cf
										Confirms that the action should be carried out.
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Remove-AdcVirtualServiceRule -RuleName ExampleRule -RuleType pre -VirtualService 10.154.11.181 -VSPort 443 -VSProtocol tcp

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.

                            

						

                        
Top of page
				

				

					

						
 Remove-AdcVsWafRule 

						
Remove a Web Application Firewall (WAF) rule from a Virtual Service.

						
This command removes the specified WAF rule from the Virtual Service.

					

                        

                        
 Syntax 

                        

						

                            


Remove-AdcVsWafRule -VS <String> -VSPort <String> -VSProtocol <String> -Rule <String> [-LoadBalancer <String>] [-LBPort 
<Int32>] [-Credential <Object>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Remove-AdcVsWafRule -VS <String> -VSPort <String> -VSProtocol <String> -Rule <String> [-LoadBalancer <String>] [-LBPort 
<Int32>] [-CertificateStoreLocation <String>] [-SubjectCN <String>] [-InformationAction <ActionPreference>] 
[-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-VS
                                        
										The address of the Virtual Service.
										true
										false
										
									

									

										-VSPort
                                        
										The port of the Virtual Service.
										true
										false
										
									

									

										-VSProtocol
                                        
										The protocol of the Virtual Service.
										true
										false
										
									

									

										-Rule
                                        
										The <RuleName> must be preceded with the relevant letter or word and a forward slash. The letter/word used depends on the 
type of rule being removed:
C or Custom
Z or ApplicationGeneric
A or ApplicationSpecific
G or Generic


This is case sensitive. The letter/word needs to be in in the correct case for the command to work.


Multiple rules can be removed in the same command by separating them with a space (or %20).		
										true
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Remove-AdcVsWafRule -Rule G/ip_reputation -VS 10.35.47.16 -VSPort 80 -VSProtocol tcp

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.

                            

						

                        
Top of page
				

				

					

						
 Remove-BondedInterface 

						
WARNING: This function is deprecated. Use the following command instead:
Remove-NetworkBondedInterface

						
WARNING: This function is deprecated. Use the following command instead:
Remove-NetworkBondedInterface

					

                        

                        
 Syntax 

                        

						

                            


Remove-BondedInterface -InterfaceID <Int16> -BondID <Int16> [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential 
<Object>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Remove-BondedInterface -InterfaceID <Int16> -BondID <Int16> [-LoadBalancer <String>] [-LBPort <Int32>] 
[-CertificateStoreLocation <String>] [-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable 
<String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-InterfaceID
                                        
										The ID of the interface that has the bond.
										true
										false
										
									

									

										-BondID
                                        
										The ID of the bonded interface to be removed.
										true
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										
										false
										false
										
									

									

										-SubjectCN
                                        
										
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Remove-BondedInterface –BondID <BondID> –InterfaceID <InterfaceID>

							    
Example Output:

                            

						

                        
Top of page
				

				

					

						
 Remove-Certificate 

						
WARNING: This function is deprecated. Use the following command instead:
Remove-TlsCertificate

						
WARNING: This function is deprecated. Use the following command instead:
Remove-TlsCertificate

					

                        

                        
 Syntax 

                        

						

                            


Remove-Certificate -Name <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-Force 
<SwitchParameter>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [-WhatIf <SwitchParameter>] 
[-Confirm <SwitchParameter>] [<CommonParameters>]

Remove-Certificate -Name <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] 
[-SubjectCN <String>] [-Force <SwitchParameter>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] 
[-WhatIf <SwitchParameter>] [-Confirm <SwitchParameter>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-Name
                                        
										
										true
										false
										
									

									

										-LoadBalancer
                                        
										
										false
										false
										
									

									

										-LBPort
                                        
										
										false
										false
										
									

									

										-Credential
                                        
										
										false
										false
										
									

									

										-Force
                                        
										
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-WhatIf
                                        wi
										
										false
										false
										
									

									

										-Confirm
                                        cf
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										
										false
										false
										
									

									

										-SubjectCN
                                        
										
										false
										false
										
									

								
							

						
				
				

				

					

						
 Remove-ClusterNode 

						
Deletes a node from a cluster.

						
Deletes a node from a cluster.

					

                        

                        
 Syntax 

                        

						

                            


Remove-ClusterNode -NodeId <Int32> [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Remove-ClusterNode -NodeId <Int32> [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] 
[-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-NodeId
                                        
										The ID number of the node to be deleted. The ID of the node can be found in the ID column in the Cluster Control screen in 
the LoadMaster WUI.		
										true
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Remove-ClusterNode -NodeId 2

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.

                            

						

                        
Top of page
				

				

					

						
 RemoveCountry 

						
WARNING: This function is deprecated. Use the following command instead:
Remove-GeoFQDNSiteCountry

						
WARNING: This function is deprecated. Use the following command instead:
Remove-GeoFQDNSiteCountry

					

                        

                        
 Syntax 

                        

						

                            


RemoveCountry -FQDN <String> -SiteAddress <String> [-CountryCode <String>] [-IsContinent <String>] [-CustomLocation 
<String>] [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction <ActionPreference>] 
[-InformationVariable <String>] [<CommonParameters>]

RemoveCountry -FQDN <String> -SiteAddress <String> [-CountryCode <String>] [-IsContinent <String>] [-CustomLocation 
<String>] [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN <String>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-FQDN
                                        
										
										true
										false
										
									

									

										-SiteAddress
                                        
										
										true
										false
										
									

									

										-CountryCode
                                        
										
										false
										false
										
									

									

										-IsContinent
                                        
										
										false
										false
										
									

									

										-CustomLocation
                                        
										
										false
										false
										
									

									

										-LoadBalancer
                                        
										
										false
										false
										
									

									

										-LBPort
                                        
										
										false
										false
										
									

									

										-Credential
                                        
										
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										
										false
										false
										
									

									

										-SubjectCN
                                        
										
										false
										false
										
									

								
							

						
				
				

				

					

						
 Remove-GeoCluster 

						
Allows you to delete an existing GEO cluster.

						
Allows you to delete an existing GEO cluster.

					

                        

                        
 Syntax 

                        

						

                            


Remove-GeoCluster -ClusterIp <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Remove-GeoCluster -ClusterIp <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] 
[-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-ClusterIp
                                        
										The IP address of the cluster.
										true
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Remove-GeoCluster –IP 10.34.52.56

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.

                            

						

                        
Top of page
				

				

					

						
 Remove-GeoCustomLocation 

						
Removes an existing custom location.

						
Removes an existing custom location.

					

                        

                        
 Syntax 

                        

						

                            


Remove-GeoCustomLocation -Location <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Remove-GeoCustomLocation -Location <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] 
[-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-Location
                                        
										The name of the location to remove.
										true
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-clName
                                        
										Specify the name of the custom location to be removed.
										true
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Remove-GeoCustomLocation -Location Example

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.

                            

						

                        
Top of page
				

				

					

						
 Remove-GeoDNSSECKeySigningKey 

						
Delete the Key Signing Key (KSK) files.

						
Remove the KSK files.

					

                        

                        
 Syntax 

                        

						

                            


Remove-GeoDNSSECKeySigningKey [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Remove-GeoDNSSECKeySigningKey [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN 
<String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Remove-GeoDNSSECKeySigningKey

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.

                            

						

                        
Top of page
				

				

					

						
 Remove-GeoFQDN 

						
Allows you to delete an existing GEO FQDN.

						
Allows you to delete an existing GEO FQDN.

					

                        

                        
 Syntax 

                        

						

                            


Remove-GeoFQDN -FQDN <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Remove-GeoFQDN -FQDN <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN 
<String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-FQDN
                                        
										The name of the FQDN.
										true
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Remove-GeoFQDN –FQDN ExampleFQDN.com

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.

                            

						

                        
Top of page
				

				

					

						
 Remove-GeoFQDNSiteAddress 

						
Allows you to delete an IP address from an FQDN.

						
Allows you to delete an IP address from an FQDN.

					

                        

                        
 Syntax 

                        

						

                            


Remove-GeoFQDNSiteAddress -FQDN <String> -SiteAddress <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential 
<Object>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Remove-GeoFQDNSiteAddress -FQDN <String> -SiteAddress <String> [-LoadBalancer <String>] [-LBPort <Int32>] 
[-CertificateStoreLocation <String>] [-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable 
<String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-FQDN
                                        
										The name of the FQDN.
										true
										false
										
									

									

										-SiteAddress
                                        
										IP address to be deleted from the FQDN.
										true
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Remove-GeoFQDNSiteAddress –FQDN Example.com -IP 10.134.33.3

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed. Deleted site 10.134.33.3 from FQDN Example.com; 
Data=}
Return Code..: 200
Response.....: Command successfully executed. Deleted site 10.134.33.3 from FQDN Example.com

                            

						

                        
Top of page
				

				

					

						
 Remove-GeoFQDNSiteCountry 

						
Remove a country assignment.

						
Allows you to remove a country assignment from a mapped IP address.

					

                        

                        
 Syntax 

                        

						

                            


Remove-GeoFQDNSiteCountry -FQDN <String> -SiteAddress <String> [-CountryCode <String>] [-IsContinent <String>] 
[-CustomLocation <String>] [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Remove-GeoFQDNSiteCountry -FQDN <String> -SiteAddress <String> [-CountryCode <String>] [-IsContinent <String>] 
[-CustomLocation <String>] [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN 
<String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-FQDN
                                        
										The name of the FQDN.
										true
										false
										
									

									

										-SiteAddress
                                        
										The address of the map to be modified.
										true
										false
										
									

									

										-CountryCode
                                        
										Two-letter country code for the country to be unassigned.
To specify everywhere as the country, type ALL as the country code and set the IsContinent parameter to yes.		
										false
										false
										
									

									

										-IsContinent
                                        
										Some country codes and continent codes are the same, for example AF could mean Africa or Afghanistan. You must specify in 
this parameter if the code is for a country or continent.
yes – code is for a continent
no – code is for a country		
										false
										false
										
									

									

										-CustomLocation
                                        
										The name of an existing custom location.
										false
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Remove-GeoFQDNSiteCountry -FQDN Example.com -SiteAddress 10.134.33.2 -CountryCode IE -IsContinent no

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed. Country/Continent updated.; Data=}
Return Code..: 200
Response.....: Command successfully executed. Country/Continent updated.

                            

						

                        
Top of page
				

				

					

						
 Remove-GeoIpRange 

						
Allows you to delete an entry from the IP range selection criteria list.

						
Allows you to delete an entry from the IP range selection criteria list.

					

                        

                        
 Syntax 

                        

						

                            


Remove-GeoIpRange -IP <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Remove-GeoIpRange -IP <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN 
<String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-IP
                                        
										The IP address of the entry to be deleted.
										true
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Remove-GeoIPRange –IP 10.134.33.2

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed. IP range deleted; Data=}
Return Code..: 200
Response.....: Command successfully executed. IP range deleted

                            

						

                        
Top of page
				

				

					

						
 Remove-GeoIPRangeCoordinates 

						
Allows you to delete the location assigned to an IP address.

						
Allows you to delete the location assigned to an IP address.

					

                        

                        
 Syntax 

                        

						

                            


Remove-GeoIPRangeCoordinates -IP <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Remove-GeoIPRangeCoordinates -IP <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] 
[-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-IP
                                        
										The IP address to be modified.
										true
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Remove-GeoIPRangeCoordinates –IP 10.154.11.55

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed. IP range location updated; Data=}
Return Code..: 200
Response.....: Command successfully executed. IP range location updated

                            

						

                        
Top of page
				

				

					

						
 Remove-GeoIPRangeCountry 

						
Allows you to unassign a country from an IP address.

						
Allows you to unassign a country from an IP address.

					

                        

                        
 Syntax 

                        

						

                            


Remove-GeoIPRangeCountry [-IP] <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Remove-GeoIPRangeCountry [-IP] <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] 
[-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-IP
                                        
										IP address to remove the country from.
										true
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Remove-GeoIPRangeCountry -IP 10.154.11.55

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed. IP range country updated; Data=}
Return Code..: 200
Response.....: Command successfully executed. IP range country updated

                            

						

                        
Top of page
				

				

					

						
 Remove-GeoIPRangeCustomLocation 

						
WARNING: This function is deprecated. Use the following command instead:
Remove-GeoIPRangeCountry

						
WARNING: This function is deprecated. Use the following command instead:
Remove-GeoIPRangeCountry

					

                        

                        
 Syntax 

                        

						

                            


Remove-GeoIPRangeCustomLocation [-IP] <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Remove-GeoIPRangeCustomLocation [-IP] <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation 
<String>] [-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-IP
                                        
										
										true
										false
										
									

									

										-LoadBalancer
                                        
										
										false
										false
										
									

									

										-LBPort
                                        
										
										false
										false
										
									

									

										-Credential
                                        
										
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										
										false
										false
										
									

									

										-SubjectCN
                                        
										
										false
										false
										
									

								
							

						
				
				

				

					

						
 Remove-GeoIPWhitelist 

						
Remove an IP address or network from the whitelist.

						
Run this command to remove the specified address from the whitelist. The whitelist entries override the blacklist.

					

                        

                        
 Syntax 

                        

						

                            


Remove-GeoIPWhitelist -Addr <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Remove-GeoIPWhitelist -Addr <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] 
[-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-Addr
                                        
										Specify the address to be removed from the user-defined whitelist.
										true
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Remove-GeoIPWhitelist -Addr 10.145.33.22

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed. 10.145.33.22 was successfully removed from GEO ACL 
white list.; Data=}
Return Code..: 200
Response.....: Command successfully executed. 10.145.33.22 was successfully removed from GEO ACL white list.

                            

						

                        
Top of page
				

				

					

						
 Remove-GlobalPacketFilterACL 

						
Removes an address from the global black or white list.

						
Removes a host or network IP address from the global black or white access control list. Note that black and white lists 
are only enabled when packet filtering is enabled.

					

                        

                        
 Syntax 

                        

						

                            


Remove-GlobalPacketFilterACL -Type <String> -Address <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential 
<Object>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Remove-GlobalPacketFilterACL -Type <String> -Address <String> [-LoadBalancer <String>] [-LBPort <Int32>] 
[-CertificateStoreLocation <String>] [-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable 
<String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-Type
                                        
										Specifies the access control list type: "black" or "white".
										true
										false
										
									

									

										-Address
                                        
										Specifies a host or network IP address to remove from the access control list. The address can be specified in CIDR format. 
If the CIDR is not specified, the system uses a default of /32.		
										true
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Remove-GlobalPacketFilterACL -Address 10.154.11.197 -Type black

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.

                            

						

                        
Top of page
				

				

					

						
 Remove-HostsEntry 

						
Deletes a host IP address and host FQDN.

						
Deletes a host IP address and host FQDN.

					

                        

                        
 Syntax 

                        

						

                            


Remove-HostsEntry -HostIP <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Remove-HostsEntry -HostIP <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] 
[-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-HostIP
                                        
										Specify the IP address for the entry.
										true
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Remove-HostsEntry -HostIP 10.154.11.180

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.

                            

						

                        
Top of page
				

				

					

						
 Remove-InterfaceAddress 

						
WARNING: This function is deprecated. Use the following command instead:
Remove-NetworkInterfaceAdditionalAddress

						
WARNING: This function is deprecated. Use the following command instead:
Remove-NetworkInterfaceAdditionalAddress

					

                        

                        
 Syntax 

                        

						

                            


Remove-InterfaceAddress [-InterfaceID <Int16>] [-Address <String>] [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential 
<Object>] [-Force <SwitchParameter>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [-WhatIf 
<SwitchParameter>] [-Confirm <SwitchParameter>] [<CommonParameters>]

Remove-InterfaceAddress [-InterfaceID <Int16>] [-Address <String>] [-LoadBalancer <String>] [-LBPort <Int32>] 
[-CertificateStoreLocation <String>] [-SubjectCN <String>] [-Force <SwitchParameter>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [-WhatIf <SwitchParameter>] [-Confirm <SwitchParameter>] 
[<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-InterfaceID
                                        
										
										false
										false
										
									

									

										-Address
                                        
										
										false
										false
										
									

									

										-LoadBalancer
                                        
										
										false
										false
										
									

									

										-LBPort
                                        
										
										false
										false
										
									

									

										-Credential
                                        
										
										false
										false
										
									

									

										-Force
                                        
										
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-WhatIf
                                        wi
										
										false
										false
										
									

									

										-Confirm
                                        cf
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										
										false
										false
										
									

									

										-SubjectCN
                                        
										
										false
										false
										
									

								
							

						
				
				

				

					

						
 Remove-IntermediateCertificate 

						
WARNING: This function is deprecated. Use the following command instead:
Remove-TlsIntermediateCertificate

						
WARNING: This function is deprecated. Use the following command instead:
Remove-TlsIntermediateCertificate

					

                        

                        
 Syntax 

                        

						

                            


Remove-IntermediateCertificate -Name <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-Force 
<SwitchParameter>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [-WhatIf <SwitchParameter>] 
[-Confirm <SwitchParameter>] [<CommonParameters>]

Remove-IntermediateCertificate -Name <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation 
<String>] [-SubjectCN <String>] [-Force <SwitchParameter>] [-InformationAction <ActionPreference>] [-InformationVariable 
<String>] [-WhatIf <SwitchParameter>] [-Confirm <SwitchParameter>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-Name
                                        
										
										true
										false
										
									

									

										-LoadBalancer
                                        
										
										false
										false
										
									

									

										-LBPort
                                        
										
										false
										false
										
									

									

										-Credential
                                        
										
										false
										false
										
									

									

										-Force
                                        
										
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-WhatIf
                                        wi
										
										false
										false
										
									

									

										-Confirm
                                        cf
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										
										false
										false
										
									

									

										-SubjectCN
                                        
										
										false
										false
										
									

								
							

						
				
				

				

					

						
 RemoveIPCountry 

						
WARNING: This function is deprecated. Use the following command instead:
Remove-GeoIPRangeCountry

						
WARNING: This function is deprecated. Use the following command instead:
Remove-GeoIPRangeCountry

					

                        

                        
 Syntax 

                        

						

                            


RemoveIPCountry [-IP] <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

RemoveIPCountry [-IP] <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN 
<String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-IP
                                        
										
										true
										false
										
									

									

										-LoadBalancer
                                        
										
										false
										false
										
									

									

										-LBPort
                                        
										
										false
										false
										
									

									

										-Credential
                                        
										
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										
										false
										false
										
									

									

										-SubjectCN
                                        
										
										false
										false
										
									

								
							

						
				
				

				

					

						
 RemoveIPCountryCustom 

						
WARNING: This function is deprecated. Use the following command instead:
Remove-GeoIPRangeCountry

						
WARNING: This function is deprecated. Use the following command instead:
Remove-GeoIPRangeCountry

					

                        

                        
 Syntax 

                        

						

                            


RemoveIPCountryCustom [-IP] <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

RemoveIPCountryCustom [-IP] <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] 
[-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-IP
                                        
										
										true
										false
										
									

									

										-LoadBalancer
                                        
										
										false
										false
										
									

									

										-LBPort
                                        
										
										false
										false
										
									

									

										-Credential
                                        
										
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										
										false
										false
										
									

									

										-SubjectCN
                                        
										
										false
										false
										
									

								
							

						
				
				

				

					

						
 Remove-LdapEndpoint 

						
Delete an existing LDAP endpoint.

						
These LDAP endpoints may be used in three different areas:
• Health checks
• SSO domains
• WUI authentication

					

                        

                        
 Syntax 

                        

						

                            


Remove-LdapEndpoint -Name <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Remove-LdapEndpoint -Name <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] 
[-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-Name
                                        
										The name of the LDAP endpoint to be deleted.
										true
										false
										
									

									

										-LoadBalancer
                                        
										The IP address of the Kemp LoadMaster that you are directing the command to. This can be set globally by using the 
Initialize-LoadBalancer command, but can be overridden on each individual command by using this parameter.		
										false
										false
										
									

									

										-LBPort
                                        
										The port of the load balancer.
										false
										false
										
									

									

										-Credential
                                        
										Specifies a user account that has permission to administer the load balancer. You can either enter a username for the load 
balancer or provide a PSCredential object, such as an object that is returned by the Get-Credential cmdlet. When you type a 
username, you are prompted for a password.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.		
										false
										false
										
									

								
							

						
				
						

                            

                                
 Note 

                            

							
It is not possible to delete an LDAP endpoint that is currently in use.

						

                        

                            
 Examples 

                        

						

                            

							    Example

Remove-LdapEndpoint -Name ExampleLDAPEndpoint

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.

                            

						

                        
Top of page
				

				

					

						
 Remove-LmAddon 

						
Deletes an Add-on pack

						
Add-on packs can be deleted by running the Remove-LmAddon command.

					

                        

                        
 Syntax 

                        

						

                            


Remove-LmAddon -Name <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Remove-LmAddon -Name <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN 
<String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-Name
                                        
										The name of the add-on pack. The names of existing add-on packs can be seen by running the ListAddons command.
										true
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Remove-LmAddon -Name Akamai

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.

                            

						

                        
Top of page
				

				

					

						
 Remove-LmIPConnectionLimit 

						
Allows you to delete an IP address limiter.

						
Allows you to delete an IP address limiter.

					

                        

                        
 Syntax 

                        

						

                            


Remove-LmIPConnectionLimit -L7addr <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Remove-LmIPConnectionLimit -L7addr <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] 
[-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-L7addr
                                        
										The IP address to be deleted.
										true
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Remove-LmIPConnectionLimit -L7addr 10.10.10.10

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.

                            

						

                        
Top of page
				

				

					

						
 Remove-LmVpnConnection 

						
Deletes an existing Virtual Private Network (VPN) connection.

						
Removes the specified VPN connection.

					

                        

                        
 Syntax 

                        

						

                            


Remove-LmVpnConnection -Name <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Remove-LmVpnConnection -Name <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] 
[-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-Name
                                        
										The name of the VPN.
										true
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Remove-LmVpnConnection -Name ExampleVPNConnection

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.

                            

						

                        
Top of page
				

				

					

						
 Remove-NetworkBondedInterface 

						
Remove a bonded interface.

						
Unlink the specified interface from the bonded interface.

					

                        

                        
 Syntax 

                        

						

                            


Remove-NetworkBondedInterface -InterfaceID <Int16> -BondID <Int16> [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential 
<Object>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Remove-NetworkBondedInterface -InterfaceID <Int16> -BondID <Int16> [-LoadBalancer <String>] [-LBPort <Int32>] 
[-CertificateStoreLocation <String>] [-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable 
<String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-InterfaceID
                                        
										The ID of the interface that has the bond.
										true
										false
										
									

									

										-BondID
                                        
										The ID of the interface to be unlinked.
										true
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Remove-NetworkBondedInterface –InterfaceID 1

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.
Data field...: @{Interface=}
Id               : 1
IPAddress        : 
NBondMembers     : 1
BondMembers      : @{RealInterface=1}
Mode             : 802.3ad
InterfaceType    : Bonded
GeoTrafficEnable : no
DefaultInterface : no

                            

						

                        
Top of page
				

				

					

						
 Remove-NetworkInterfaceAdditionalAddress 

						
Remove an additional address from an interface.

						
Run this command to remove an existing additional address from an interface.

					

                        

                        
 Syntax 

                        

						

                            


Remove-NetworkInterfaceAdditionalAddress [-InterfaceID <Int16>] [-Address <String>] [-LoadBalancer <String>] [-LBPort 
<Int32>] [-Credential <Object>] [-Force <SwitchParameter>] [-InformationAction <ActionPreference>] [-InformationVariable 
<String>] [-WhatIf <SwitchParameter>] [-Confirm <SwitchParameter>] [<CommonParameters>]

Remove-NetworkInterfaceAdditionalAddress [-InterfaceID <Int16>] [-Address <String>] [-LoadBalancer <String>] [-LBPort 
<Int32>] [-CertificateStoreLocation <String>] [-SubjectCN <String>] [-Force <SwitchParameter>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [-WhatIf <SwitchParameter>] [-Confirm <SwitchParameter>] 
[<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-InterfaceID
                                        
										The ID of the interface to remove the additional address from.
										false
										false
										
									

									

										-Address
                                        
										The address to be removed, in the format <IPAddress>/<CIDR>.
										false
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-Force
                                        
										Enable this parameter to force the command to execute without a confirmation.
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-WhatIf
                                        wi
										Enable this parameter to see what the command will do without actually executing the command.
										false
										false
										
									

									

										-Confirm
                                        cf
										Confirms that the action should be carried out.
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Remove-NetworkInterfaceAdditionalAddress -Address 10.154.11.22/16

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.

                            

						

                        
Top of page
				

				

					

						
 Remove-NetworkRoute 

						
Removes a route.

						
Removes a route.

					

                        

                        
 Syntax 

                        

						

                            


Remove-NetworkRoute -Destination <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Remove-NetworkRoute -Destination <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] 
[-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-Destination
                                        
										The destination network that should be removed from the routing table.
										true
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Remove-NetworkRoute -Destination 10.154.11.33

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.
Data field...: @{Route=}
Destination : 10.154.11.24/16
Gateway     : 10.154.11.44

                            

						

                        
Top of page
				

				

					

						
 Remove-NetworkVLAN 

						
Allows you to remove a Virtual LAN.

						
Allows you to remove a Virtual LAN.

					

                        

                        
 Syntax 

                        

						

                            


Remove-NetworkVLAN -InterfaceID <Int16> [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Remove-NetworkVLAN -InterfaceID <Int16> [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] 
[-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-InterfaceID
                                        
										The ID of the interface that should be removed from the VLAN.
										true
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Remove-NetworkVLAN -InterfaceID 2

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.
Data field...:

                            

						

                        
Top of page
				

				

					

						
 Remove-NetworkVxLAN 

						
Deletes the specified VXLAN.

						
Deletes the specified VXLAN.

					

                        

                        
 Syntax 

                        

						

                            


Remove-NetworkVxLAN -InterfaceID <Int16> [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Remove-NetworkVxLAN -InterfaceID <Int16> [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] 
[-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-InterfaceID
                                        
										The ID of the interface.
										true
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Remove-NetworkVxLAN -InterfaceID 2

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.

                            

						

                        
Top of page
				

				

					

						
 Remove-NoCacheExtension 

						
WARNING: This function is deprecated. Use the following command instead:
Remove-AdcHttpCacheException

						
WARNING: This function is deprecated. Use the following command instead:
Remove-AdcHttpCacheException

					

                        

                        
 Syntax 

                        

						

                            


Remove-NoCacheExtension -Extension <String[]> [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Remove-NoCacheExtension -Extension <String[]> [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation 
<String>] [-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-Extension
                                        
										
										true
										true (ByValue)
										
									

									

										-LoadBalancer
                                        
										
										false
										false
										
									

									

										-LBPort
                                        
										
										false
										false
										
									

									

										-Credential
                                        
										
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										
										false
										false
										
									

									

										-SubjectCN
                                        
										
										false
										false
										
									

								
							

						
				
				

				

					

						
 Remove-NoCompressExtension 

						
WARNING: This function is deprecated. Use the following command instead:
Remove-AdcHttpCompressionException

						
WARNING: This function is deprecated. Use the following command instead:
Remove-AdcHttpCompressionException

					

                        

                        
 Syntax 

                        

						

                            


Remove-NoCompressExtension -Extension <String[]> [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Remove-NoCompressExtension -Extension <String[]> [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation 
<String>] [-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-Extension
                                        
										
										true
										true (ByValue)
										
									

									

										-LoadBalancer
                                        
										
										false
										false
										
									

									

										-LBPort
                                        
										
										false
										false
										
									

									

										-Credential
                                        
										
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										
										false
										false
										
									

									

										-SubjectCN
                                        
										
										false
										false
										
									

								
							

						
				
				

				

					

						
 Remove-RealServer 

						
WARNING: This function is deprecated. Use the following command instead:
Remove-AdcRealServer

						
WARNING: This function is deprecated. Use the following command instead:
Remove-AdcRealServer

					

                        

                        
 Syntax 

                        

						

                            


Remove-RealServer [-VirtualService <String>] [-VSPort <Int32>] [-VSProtocol <String>] [-VSIndex <Int32>] [-RealServer 
<String>] [-RealServerPort <Int32>] [-RSIndex <Int32>] [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] 
[-Force <SwitchParameter>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [-WhatIf 
<SwitchParameter>] [-Confirm <SwitchParameter>] [<CommonParameters>]

Remove-RealServer [-VirtualService <String>] [-VSPort <Int32>] [-VSProtocol <String>] [-VSIndex <Int32>] [-RealServer 
<String>] [-RealServerPort <Int32>] [-RSIndex <Int32>] [-LoadBalancer <String>] [-LBPort <Int32>] 
[-CertificateStoreLocation <String>] [-SubjectCN <String>] [-Force <SwitchParameter>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [-WhatIf <SwitchParameter>] [-Confirm <SwitchParameter>] 
[<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-VirtualService
                                        
										
										false
										false
										
									

									

										-VSPort
                                        
										
										false
										false
										
									

									

										-VSProtocol
                                        
										
										false
										false
										
									

									

										-VSIndex
                                        
										
										false
										false
										
									

									

										-RealServer
                                        
										
										false
										false
										
									

									

										-RealServerPort
                                        
										
										false
										false
										
									

									

										-RSIndex
                                        
										
										false
										false
										
									

									

										-LoadBalancer
                                        
										
										false
										false
										
									

									

										-LBPort
                                        
										
										false
										false
										
									

									

										-Credential
                                        
										
										false
										false
										
									

									

										-Force
                                        
										
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-WhatIf
                                        wi
										
										false
										false
										
									

									

										-Confirm
                                        cf
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										
										false
										false
										
									

									

										-SubjectCN
                                        
										
										false
										false
										
									

								
							

						
				
				

				

					

						
 Remove-RealServerRule 

						
WARNING: This function is deprecated. Use the following command instead:
Remove-AdcRealServerRule

						
WARNING: This function is deprecated. Use the following command instead:
Remove-AdcRealServerRule

					

                        

                        
 Syntax 

                        

						

                            


Remove-RealServerRule [-VirtualService <String>] [-VSPort <Int32>] [-VSProtocol <String>] [-VSIndex <Int32>] [-RealServer 
<String>] [-RSPort <Int32>] [-RSIndex <Int32>] -RuleName <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential 
<Object>] [-Force <SwitchParameter>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [-WhatIf 
<SwitchParameter>] [-Confirm <SwitchParameter>] [<CommonParameters>]

Remove-RealServerRule [-VirtualService <String>] [-VSPort <Int32>] [-VSProtocol <String>] [-VSIndex <Int32>] [-RealServer 
<String>] [-RSPort <Int32>] [-RSIndex <Int32>] -RuleName <String> [-LoadBalancer <String>] [-LBPort <Int32>] 
[-CertificateStoreLocation <String>] [-SubjectCN <String>] [-Force <SwitchParameter>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [-WhatIf <SwitchParameter>] [-Confirm <SwitchParameter>] 
[<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-VirtualService
                                        
										
										false
										false
										
									

									

										-VSPort
                                        
										
										false
										false
										
									

									

										-VSProtocol
                                        
										
										false
										false
										
									

									

										-VSIndex
                                        
										
										false
										false
										
									

									

										-RealServer
                                        
										
										false
										false
										
									

									

										-RSPort
                                        
										
										false
										false
										
									

									

										-RSIndex
                                        
										
										false
										false
										
									

									

										-RuleName
                                        
										
										true
										false
										
									

									

										-LoadBalancer
                                        
										
										false
										false
										
									

									

										-LBPort
                                        
										
										false
										false
										
									

									

										-Credential
                                        
										
										false
										false
										
									

									

										-Force
                                        
										
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-WhatIf
                                        wi
										
										false
										false
										
									

									

										-Confirm
                                        cf
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										
										false
										false
										
									

									

										-SubjectCN
                                        
										
										false
										false
										
									

								
							

						
				
				

				

					

						
 Remove-Route 

						
WARNING: This function is deprecated. Use the following command instead:
Remove-NetworkRoute

						
WARNING: This function is deprecated. Use the following command instead:
Remove-NetworkRoute

					

                        

                        
 Syntax 

                        

						

                            


Remove-Route -Destination <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Remove-Route -Destination <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] 
[-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-Destination
                                        
										
										true
										false
										
									

									

										-LoadBalancer
                                        
										
										false
										false
										
									

									

										-LBPort
                                        
										
										false
										false
										
									

									

										-Credential
                                        
										
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										
										false
										false
										
									

									

										-SubjectCN
                                        
										
										false
										false
										
									

								
							

						
				
				

				

					

						
 Remove-Rule 

						
WARNING: This function is deprecated. Use the following command instead:
Remove-AdcContentRule

						
WARNING: This function is deprecated. Use the following command instead:
Remove-AdcContentRule

					

                        

                        
 Syntax 

                        

						

                            


Remove-Rule -RuleName <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-Force <SwitchParameter>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [-WhatIf <SwitchParameter>] [-Confirm 
<SwitchParameter>] [<CommonParameters>]

Remove-Rule -RuleName <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN 
<String>] [-Force <SwitchParameter>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [-WhatIf 
<SwitchParameter>] [-Confirm <SwitchParameter>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-RuleName
                                        
										
										true
										true (ByValue)
										
									

									

										-LoadBalancer
                                        
										
										false
										false
										
									

									

										-LBPort
                                        
										
										false
										false
										
									

									

										-Credential
                                        
										
										false
										false
										
									

									

										-Force
                                        
										
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-WhatIf
                                        wi
										
										false
										false
										
									

									

										-Confirm
                                        cf
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										
										false
										false
										
									

									

										-SubjectCN
                                        
										
										false
										false
										
									

								
							

						
				
				

				

					

						
 Remove-SdnController 

						
Deletes an SDN controller from the LoadMaster.

						
Deletes an SDN controller from the LoadMaster.

					

                        

                        
 Syntax 

                        

						

                            


Remove-SdnController [-Clid <Int32>] [-Cid <Int32>] [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Remove-SdnController [-Clid <Int32>] [-Cid <Int32>] [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation 
<String>] [-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-Clid
                                        
										The unique ID of the cluster that the SDN controller is a member of.
										false
										false
										
									

									

										-Cid
                                        
										The ID number of the SDN controller.
										false
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
						

                            

                                
 Note 

                            

							
Either the Cluster ID (Clid) or the Controller ID (Cid) must be specified when running this command.

						

                        

                            
 Examples 

                        

						

                            

							    Example

Remove-SdnController -Clid 1 -Cid 1

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.

                            

						

                        
Top of page
				

				

					

						
 Remove-SecRemoteUserGroup 

						
Delete an existing remote user group.

						
These groups can be used to provide WUI authentication.

					

                        

                        
 Syntax 

                        

						

                            


Remove-SecRemoteUserGroup -Group <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Remove-SecRemoteUserGroup -Group <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] 
[-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-Group
                                        
										The name of the group to delete.
										true
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Remove-SecRemoteUserGroup -Group ExampleGroup4

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.

                            

						

                        
Top of page
				

				

					

						
 Remove-SecUser 

						
Allows you to delete a local user.

						
Allows you to delete a local user.

					

                        

                        
 Syntax 

                        

						

                            


Remove-SecUser -User <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-Force <SwitchParameter>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [-WhatIf <SwitchParameter>] [-Confirm 
<SwitchParameter>] [<CommonParameters>]

Remove-SecUser -User <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN 
<String>] [-Force <SwitchParameter>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [-WhatIf 
<SwitchParameter>] [-Confirm <SwitchParameter>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-User
                                        
										Username of the relevant user.
										true
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-Force
                                        
										Enable this parameter to force the command to execute without a confirmation.
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-WhatIf
                                        wi
										Enable this parameter to see what the command will do without actually executing the command.
										false
										false
										
									

									

										-Confirm
                                        cf
										Confirms that the action should be carried out.
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Remove-SecUser -User ExampleUser

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.

                            

						

                        
Top of page
				

				

					

						
 Remove-SecUserCertificate 

						
Delete an existing user certificate.

						
Delete an existing user certificate.

					

                        

                        
 Syntax 

                        

						

                            


Remove-SecUserCertificate -User <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Remove-SecUserCertificate -User <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] 
[-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-User
                                        
										The username of the user to delete the certificate for.
										true
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Remove-SecUserCertificate -User Example

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.

                            

						

                        
Top of page
				

				

					

						
 Remove-SplaInstance 

						
Allows you to deactivate the client LoadMaster license.

						
Allows you to deactivate the client LoadMaster license.
Note: Kemp strongly recommends deregistering a LoadMaster using the Kemp 360 Central WUI/API, rather than the LoadMaster 
WUI/API. Deregistering a LoadMaster from the LoadMaster UI/API can lead to the LoadMaster having an unknown state in Kemp 
360 Central. In these cases, it is not easy to remove the LoadMaster from Kemp 360 Central and the unknown LoadMaster is 
still taking up an available license.

					

                        

                        
 Syntax 

                        

						

                            


Remove-SplaInstance -KempId <String> -Password <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Remove-SplaInstance -KempId <String> -Password <String> [-LoadBalancer <String>] [-LBPort <Int32>] 
[-CertificateStoreLocation <String>] [-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable 
<String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-KempId
                                        
										The KempID to connect to the LoadMaster with.
										true
										false
										
									

									

										-Password
                                        
										The password to connect to the LoadMaster with.
										true
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
				

				

					

						
 Remove-SSODomain 

						
Deletes the specified SSO domain.

						
Deletes the specified SSO domain.

					

                        

                        
 Syntax 

                        

						

                            


Remove-SSODomain -Domain <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-Force 
<SwitchParameter>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [-WhatIf <SwitchParameter>] 
[-Confirm <SwitchParameter>] [<CommonParameters>]

Remove-SSODomain -Domain <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] 
[-SubjectCN <String>] [-Force <SwitchParameter>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] 
[-WhatIf <SwitchParameter>] [-Confirm <SwitchParameter>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-Domain
                                        Name
										The domain to be removed from the SSO Domain list. This parameter is required.
										true
										true (ByValue)
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-Force
                                        
										Switch to force the command to execute without a confirmation.
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-WhatIf
                                        wi
										Provides a method to see what the command will do without actually executing the command.
										false
										false
										
									

									

										-Confirm
                                        cf
										Confirms that the action should be carried out.
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Remove-SSODomain -Domain example3.com

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed (Domain "example3.com" deleted); Data=}
Return Code..: 200
Response.....: Command successfully executed (Domain "example3.com" deleted)

                            

						

                        
Top of page
				

				

					

						
 Remove-Template 

						
Allows you to remove a template from the LoadMaster.

						
Allows you to remove a template from the LoadMaster.

					

                        

                        
 Syntax 

                        

						

                            


Remove-Template -Name <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Remove-Template -Name <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN 
<String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-Name
                                        
										The name of the template as it appears in the Name column in the LoadMaster.
										true
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Remove-Template -Name "Exchange 2013 IMAP"

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.

                            

						

                        
Top of page
				

				

					

						
 Remove-TlsCertificate 

						
Allows you to remove a certificate from the LoadMaster.

						
Allows you to remove a certificate from the LoadMaster.

					

                        

                        
 Syntax 

                        

						

                            


Remove-TlsCertificate -Name <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-Force 
<SwitchParameter>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [-WhatIf <SwitchParameter>] 
[-Confirm <SwitchParameter>] [<CommonParameters>]

Remove-TlsCertificate -Name <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] 
[-SubjectCN <String>] [-Force <SwitchParameter>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] 
[-WhatIf <SwitchParameter>] [-Confirm <SwitchParameter>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-Name
                                        
										The name of the certificate to be removed from the LoadMaster.
										true
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-Force
                                        
										Enable this parameter to force the command to execute without a confirmation.
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-WhatIf
                                        wi
										Provides a method to see what the command will do without actually executing the command.
										false
										false
										
									

									

										-Confirm
                                        cf
										Confirms that the action should be carried out.
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
						

                            

                                
 Note 

                            

							
It is not possible to delete a certificate which is assigned to a Virtual Service. Un-assign the certificate from any 
    Virtual Services before deleting.

						

                        

                            
 Examples 

                        

						

                            

							    Example

Remove-TlsCertificate -Name testcert

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.

                            

						

                        
Top of page
				

				

					

						
 Remove-TlsCipherSet 

						
Delete a custom cipher set.

						
Deletes an existing custom cipher set. A custom cipher set cannot be deleted if it is assigned to any Virtual Services.

					

                        

                        
 Syntax 

                        

						

                            


Remove-TlsCipherSet -Name <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Remove-TlsCipherSet -Name <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] 
[-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-Name
                                        
										The name of the cipher set.
										true
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Remove-TlsCipherSet -Name ExampleCipherSet

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.

                            

						

                        
Top of page
				

				

					

						
 Remove-TlsIntermediateCertificate 

						
Allows you to remove a certificate from the LoadMaster.

						
Allows you to remove a certificate from the LoadMaster.

					

                        

                        
 Syntax 

                        

						

                            


Remove-TlsIntermediateCertificate -Name <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-Force 
<SwitchParameter>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [-WhatIf <SwitchParameter>] 
[-Confirm <SwitchParameter>] [<CommonParameters>]

Remove-TlsIntermediateCertificate -Name <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation 
<String>] [-SubjectCN <String>] [-Force <SwitchParameter>] [-InformationAction <ActionPreference>] [-InformationVariable 
<String>] [-WhatIf <SwitchParameter>] [-Confirm <SwitchParameter>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-Name
                                        
										The name of the intermediate certificate to remove.
										true
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-Force
                                        
										Enable this parameter to force the command to execute without a confirmation.
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-WhatIf
                                        wi
										Enable this parameter to see what the command will do without actually executing the command.
										false
										false
										
									

									

										-Confirm
                                        cf
										A switch which confirms that the action should be carried out.
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Remove-TlsIntermediateCertificate -Name testcert

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.

                            

						

                        
Top of page
				

				

					

						
 Remove-VirtualServerRule 

						
WARNING: This function is deprecated. Use the following command instead:
Remove-AdcVirtualServiceRule

						
WARNING: This function is deprecated. Use the following command instead:
Remove-AdcVirtualServiceRule

					

                        

                        
 Syntax 

                        

						

                            


Remove-VirtualServerRule [-VirtualService <String>] [-VSPort <Int32>] [-VSProtocol <String>] [-VSIndex <Int32>] -RuleType 
<String> -RuleName <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-Force <SwitchParameter>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [-WhatIf <SwitchParameter>] [-Confirm 
<SwitchParameter>] [<CommonParameters>]

Remove-VirtualServerRule [-VirtualService <String>] [-VSPort <Int32>] [-VSProtocol <String>] [-VSIndex <Int32>] -RuleType 
<String> -RuleName <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN 
<String>] [-Force <SwitchParameter>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [-WhatIf 
<SwitchParameter>] [-Confirm <SwitchParameter>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-VirtualService
                                        
										
										false
										false
										
									

									

										-VSPort
                                        
										
										false
										false
										
									

									

										-VSProtocol
                                        
										
										false
										false
										
									

									

										-VSIndex
                                        
										
										false
										false
										
									

									

										-RuleType
                                        
										
										true
										false
										
									

									

										-RuleName
                                        
										
										true
										false
										
									

									

										-LoadBalancer
                                        
										
										false
										false
										
									

									

										-LBPort
                                        
										
										false
										false
										
									

									

										-Credential
                                        
										
										false
										false
										
									

									

										-Force
                                        
										
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-WhatIf
                                        wi
										
										false
										false
										
									

									

										-Confirm
                                        cf
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										
										false
										false
										
									

									

										-SubjectCN
                                        
										
										false
										false
										
									

								
							

						
				
				

				

					

						
 Remove-VirtualService 

						
WARNING: This function is deprecated. Use the following command instead:
Remove-AdcVirtualService

						
WARNING: This function is deprecated. Use the following command instead:
Remove-AdcVirtualService

					

                        

                        
 Syntax 

                        

						

                            


Remove-VirtualService [-VirtualService <String>] [-VSPort <Int32>] [-VSProtocol <String>] [-VSIndex <Int32>] [-LoadBalancer 
<String>] [-LBPort <Int32>] [-Credential <Object>] [-Force <SwitchParameter>] [-InformationAction <ActionPreference>] 
[-InformationVariable <String>] [-WhatIf <SwitchParameter>] [-Confirm <SwitchParameter>] [<CommonParameters>]

Remove-VirtualService [-VirtualService <String>] [-VSPort <Int32>] [-VSProtocol <String>] [-VSIndex <Int32>] [-LoadBalancer 
<String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN <String>] [-Force <SwitchParameter>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [-WhatIf <SwitchParameter>] [-Confirm 
<SwitchParameter>] [<CommonParameters>]

Remove-VirtualService [-VirtualService <String>] [-VSPort <Int32>] [-VSProtocol <String>] [-LoadBalancer <String>] [-LBPort 
<Int32>] [-Force <SwitchParameter>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [-WhatIf 
<SwitchParameter>] [-Confirm <SwitchParameter>] [<CommonParameters>]

Remove-VirtualService [-VSIndex <Int32>] [-LoadBalancer <String>] [-LBPort <Int32>] [-Force <SwitchParameter>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [-WhatIf <SwitchParameter>] [-Confirm 
<SwitchParameter>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-VirtualService
                                        
										
										false
										false
										
									

									

										-VSPort
                                        
										
										false
										false
										
									

									

										-VSProtocol
                                        
										
										false
										false
										
									

									

										-VSIndex
                                        
										
										false
										false
										
									

									

										-LoadBalancer
                                        
										
										false
										false
										
									

									

										-LBPort
                                        
										
										false
										false
										
									

									

										-Credential
                                        
										
										false
										false
										
									

									

										-Force
                                        
										
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-WhatIf
                                        wi
										
										false
										false
										
									

									

										-Confirm
                                        cf
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										
										false
										false
										
									

									

										-SubjectCN
                                        
										
										false
										false
										
									

								
							

						
				
				

				

					

						
 Remove-VLan 

						
WARNING: This function is deprecated. Use the following command instead:
Remove-NetworkVLAN

						
WARNING: This function is deprecated. Use the following command instead:
Remove-NetworkVLAN

					

                        

                        
 Syntax 

                        

						

                            


Remove-VLan -InterfaceID <Int16> [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Remove-VLan -InterfaceID <Int16> [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] 
[-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-InterfaceID
                                        
										
										true
										false
										
									

									

										-LoadBalancer
                                        
										
										false
										false
										
									

									

										-LBPort
                                        
										
										false
										false
										
									

									

										-Credential
                                        
										
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										
										false
										false
										
									

									

										-SubjectCN
                                        
										
										false
										false
										
									

								
							

						
				
				

				

					

						
 Remove-VSPacketFilterACL 

						
Removes an address from the black or white list for a Virtual Service.

						
Removes a host or network IP address from the black or white access control list for a specific Virtual Service. Note that 
black and white lists are only enabled when packet filtering is enabled.

					

                        

                        
 Syntax 

                        

						

                            


Remove-VSPacketFilterACL [-VirtualService <String>] [-VSPort <Int32>] [-VSProtocol <String>] [-VSIndex <Int32>] -Type 
<String> -AclAddress <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Remove-VSPacketFilterACL [-VirtualService <String>] [-VSPort <Int32>] [-VSProtocol <String>] [-VSIndex <Int32>] -Type 
<String> -AclAddress <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN 
<String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-VirtualService
                                        
										Specifies the Virtual Service IP address.
										false
										false
										
									

									

										-VSPort
                                        
										Specifies the Virtual Service port number.
										false
										false
										
									

									

										-VSProtocol
                                        
										Specifies the Virtual Service protocol.
										false
										false
										
									

									

										-VSIndex
                                        
										The index number of the relevant Virtual Service. To retrieve the Virtual Service index, run the Get-AdcVirtualService 
command.		
										false
										false
										
									

									

										-Type
                                        
										Specify the type of list:
   - black: blocked addresses
   - white: allowed addresses
Note: This is case sensitive – the type value should be in lowercase.		
										true
										false
										
									

									

										-AclAddress
                                        
										Specifies a host or network IP address to remove from the access control list. The address can be specified in CIDR format. 
If the CIDR is not specified, the system uses a default of /32.		
										true
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Remove-VSPacketFilterACL -AclAddress 10.134.33.2 -Type black -VirtualService 10.35.47.16 -VSPort 80 -VSProtocol tcp

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.

                            

						

                        
Top of page
				

				

					

						
 Remove-VxLan 

						
WARNING: This function is deprecated. Use the following command instead:
Remove-NetworkVxLAN

						
WARNING: This function is deprecated. Use the following command instead:
Remove-NetworkVxLAN

					

                        

                        
 Syntax 

                        

						

                            


Remove-VxLan -InterfaceID <Int16> [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Remove-VxLan -InterfaceID <Int16> [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] 
[-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-InterfaceID
                                        
										
										true
										false
										
									

									

										-LoadBalancer
                                        
										
										false
										false
										
									

									

										-LBPort
                                        
										
										false
										false
										
									

									

										-Credential
                                        
										
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										
										false
										false
										
									

									

										-SubjectCN
                                        
										
										false
										false
										
									

								
							

						
				
				

				

					

						
 Request-LicenseOffline 

						
Initially license the LoadMaster using the offline licensing method.

						
A BLOB is needed to license the LoadMaster using the offline method.

					

                        

                        
 Syntax 

                        

						

                            


Request-LicenseOffline [-Path] <String> [[-LoadBalancer] <String>] [[-LBPort] <Int32>] [[-Credential] <Object>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-Path
                                        
										The BLOB is emailed to you when requested. Each time a license is updated a new BLOB is needed. The BLOB is the body of 
text in the email from the word begin to the word end. The BLOB must be copied and pasted into a text file. If the BLOB 
file is in the current directory, you only need to specify the filename. If it is in a different directory, please specify 
the path in addition to the filename.		
										true
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

								
							

						
				
						

                            

                                
 Note 

                            

							
Certificate-based authentication cannot be used to run this command because this command is used before the LoadMaster 
    is licensed.

						

                        

                            
 Examples 

                        

						

                            

							    Example

Request-LicenseOffline -Path c:\t\test.txt

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.

                            

						

                        
Top of page
				

				

					

						
 Request-LicenseOnline 

						
License the LoadMaster using the online method.

						
Cause the LoadMaster to query the Kemp licensing system for a license.

					

                        

                        
 Syntax 

                        

						

                            


Request-LicenseOnline [[-LoadBalancer] <String>] [[-LBPort] <Int32>] [[-Credential] <Object>] [-KempId] <String> 
[-Password] <String> [[-OrderId] <String>] [[-LicenseTypeId] <String>] [[-http_proxy] <String>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-KempId
                                        
										The Kemp ID is the email address which was used when registering for a Kemp ID.
										true
										false
										
									

									

										-Password
                                        
										The password of the Kemp ID account.
										true
										false
										
									

									

										-OrderId
                                        
										The Orderid parameter is only needed for Virtual LoadMasters. The Order ID is provided by Kemp after a license is purchased.
										false
										false
										
									

									

										-LicenseTypeId
                                        
										The ID of the license type to be applied. To retrieve a list of available IDs, run the Get-LicenseType command.
										false
										false
										
									

									

										-http_proxy
                                        
										Specify the HTTP(S) proxy server and port the LoadMaster will use to access the internet.
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

								
							

						
				
						

                            

                                
 Note 

                            

							
Certificate-based authentication cannot be used to run this command because this command is used before the LoadMaster 
    is licensed.

						

                        

                            
 Examples 

                        

						

                            

							    Example

Request-LicenseOnline -KempId jbloggs@kemptechnologies.com -Password examplepassword -LoadBalancer 10.154.11.60

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.

                            

						

                        
Top of page
				

				

					

						
 Request-LicenseOnPremise 

						
Use Local Activation to license the LoadMaster via Kemp 360 Central.

						
Specify the Kemp 360 Central details in the parameters in order to license the LoadMaster using Local Activation.

					

                        

                        
 Syntax 

                        

						

                            


Request-LicenseOnPremise [-aslhost <String>] [-aslport <Int32>] [-LicenseTypeId <String>] [-LoadBalancer <String>] [-LBPort 
<Int32>] [-Credential <Object>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Request-LicenseOnPremise [-aslhost <String>] [-aslport <Int32>] [-LicenseTypeId <String>] [-LoadBalancer <String>] [-LBPort 
<Int32>] [-CertificateStoreLocation <String>] [-SubjectCN <String>] [-InformationAction <ActionPreference>] 
[-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-aslhost
                                        
										Type the hostname of Kemp 360 Central. The aslhost parameter was introduced in LoadMaster firmware version 7.2.43. The 
parameters previously used were called aslipaddr and aslname. If you have scripts using these old parameters, you will need 
to update them to use the new aslhost parameter if upgrading.		
										false
										false
										
									

									

										-aslport
                                        
										The port to contact Kemp 360 Central on.
										false
										false
										
									

									

										-LicenseTypeId
                                        
										Specify the LicenseTypeId of the license to activate. To retrieve a list of license types and IDs, run the 
Get-AslLicenseType command.		
										false
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										
										false
										false
										
									

									

										-SubjectCN
                                        
										
										false
										false
										
									

									

										-aslipaddr
                                        
										The IP address of the Kemp 360 Central machine to be used for activation.
										false
										false
										
									

									

										-aslname
                                        
										The hostname of the Kemp 360 Central machine to be used for activation.
										false
										false
										
									

									

										-aslipaddress
                                        
										The IP address of the Kemp 360 Central machine to be used for activation.
										false
										false
										
									

								
							

						
				
						

                            

                                
 Note 

                            

							
Either the aslipaddr or aslname parameter must be provided for this command to run successfully.

						

                        

                            
 Examples 

                        

						

                            

							    Example

Request-LicenseOnPremise -aslipaddr 172.16.128.69 -aslname lm-act-server-default -aslport 443

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.
Data.........: @{AslServerIpAddress=172.16.128.69; AslServerPort=443; AslServerFqdn=lm-act-server-default}

                            

						

                        
Top of page
				

				

					

						
 Reset-LmExtendedLogFile 

						
Clear the extended log files.

						
To clear all the extended log files, run the command without the FileToReset parameter. To clear specific extended log 
files, enter a space-separated list of log files to clear in the FileToReset parameter.

					

                        

                        
 Syntax 

                        

						

                            


Reset-LmExtendedLogFile [-FileToReset <String>] [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Reset-LmExtendedLogFile [-FileToReset <String>] [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation 
<String>] [-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-FileToReset
                                        
										To clear specific ESP log files, enter a space-separated list of log files. For example, security-20181128.gz 
security-20181211.gz.		
										false
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\&lt;CurrentUser&gt;\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Reset-LmExtendedLogFile -FileToReset "security-20181128.gz security-20181211.gz"

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=@{SyslogResetFiles=Reset files: all}}
Return Code..: 200
Response.....: Command successfully executed.
ReturnCode Response                       Data
---------- --------                       ----
       200 Command successfully executed.

                            

						

                        
Top of page
				

				

					

						
 Reset-LmSyslogFile 

						
Clear the system log files.

						
Run this command to clear the system log files.

					

                        

                        
 Syntax 

                        

						

                            


Reset-LmSyslogFile [-FileToReset <String>] [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Reset-LmSyslogFile [-FileToReset <String>] [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] 
[-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-FileToReset
                                        
										To clear specific log files, specifcy a space-separated list of LoadMaster syslog files. For example, named.log warn.
To retrieve the names of the LoadMaster syslog files that can be entered here, run the Get-LmSyslogFie command.		
										false
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Reset-LmSyslogFile

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=@{SyslogResetFiles=Reset files: all}}
Return Code..: 200
Response.....: Command successfully executed.
SyslogResetFiles
----------------
Reset files: all

                            

						

                        
Top of page
				

				

					

						
 Reset-LmWafDebugLogs 

						
Reset the WAF debug/event logs.

						
Clear the Web Application Firewall (WAF) debug and event logs.

					

                        

                        
 Syntax 

                        

						

                            


Reset-LmWafDebugLogs [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Reset-LmWafDebugLogs [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN <String>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Reset-LmWafDebugLogs

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.

                            

						

                        
Top of page
				

				

					

						
 Reset-LmWafTempRemoteLog 

					

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-CertificateStoreLocation
                                        None
										
										false
										false
										
									

									

										-Credential
                                        None
										
										false
										false
										
									

									

										-LBPort
                                        None
										
										false
										false
										
									

									

										-LoadBalancer
                                        None
										
										false
										false
										
									

									

										-SubjectCN
                                        None
										
										false
										false
										
									

								
							

						
				
				

				

					

						
 Reset-LogStatistics 

						
Reset the LoadMaster statistics.

						
Reset the LoadMaster statistics (total connections, Bytes per Second, and so on) that can be retreived with the 
Get-LogStatistics command.

					

                        

                        
 Syntax 

                        

						

                            


Reset-LogStatistics [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Reset-LogStatistics [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN <String>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Reset-LogStatistics

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.

                            

						

                        
Top of page
				

				

					

						
 Restart-Lm 

						
Allows you to restart the LoadMaster.

						
Allows you to restart the LoadMaster.

					

                        

                        
 Syntax 

                        

						

                            


Restart-Lm [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-Shutdown <SwitchParameter>] [-Force 
<SwitchParameter>] [-SleepTime <Int32>] [-Cycles <Int32>] [-InformationAction <ActionPreference>] [-InformationVariable 
<String>] [-WhatIf <SwitchParameter>] [-Confirm <SwitchParameter>] [<CommonParameters>]

Restart-Lm [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN <String>] [-Shutdown 
<SwitchParameter>] [-Force <SwitchParameter>] [-SleepTime <Int32>] [-Cycles <Int32>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [-WhatIf <SwitchParameter>] [-Confirm <SwitchParameter>] 
[<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-Shutdown
                                        
										Specifies to shut down the LoadMaster. Issuing this command will require physical access to power the LoadMaster back on.
										false
										false
										
									

									

										-Force
                                        
										Enable this command to force the command to execute without a confirmation.
										false
										false
										
									

									

										-SleepTime
                                        
										This parameter is not mandatory. The SleepTime parameter defines the amount of wait time. The default value is 12 seconds.
The Cycles parameter value defines the amount of cycles of sleep time to wait for. The default value is 8 seconds. 
Therefore, by default the API waits for 96 seconds when the Restart-Lm command is run.		
										false
										false
										
									

									

										-Cycles
                                        
										This parameter is not mandatory. The Cycles parameter value defines the amount of cycles of sleep time that is waited for. 
The default is 8 seconds. The SleepTime parameter defines the amount of wait time. The default value is 12 seconds.
Therefore, by default the API waits for 96 seconds when the Restart-Lm command is run.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-WhatIf
                                        wi
										Enable this command to see what the command will do without actually executing the command.
										false
										false
										
									

									

										-Confirm
                                        cf
										Confirms that the action should be carried out.
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Restart-Lm -Confirm -Force

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.

                            

						

                        
Top of page
				

				

					

						
 Restart-LoadBalancer 

						
WARNING: This function is deprecated. Use the following command instead:
Restart-Lm

						
WARNING: This function is deprecated. Use the following command instead:
Restart-Lm

					

                        

                        
 Syntax 

                        

						

                            


Restart-LoadBalancer [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-Shutdown <SwitchParameter>] 
[-Force <SwitchParameter>] [-SleepTime <Int32>] [-Cycles <Int32>] [-InformationAction <ActionPreference>] 
[-InformationVariable <String>] [-WhatIf <SwitchParameter>] [-Confirm <SwitchParameter>] [<CommonParameters>]

Restart-LoadBalancer [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN <String>] 
[-Shutdown <SwitchParameter>] [-Force <SwitchParameter>] [-SleepTime <Int32>] [-Cycles <Int32>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [-WhatIf <SwitchParameter>] [-Confirm <SwitchParameter>] 
[<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-LoadBalancer
                                        
										
										false
										false
										
									

									

										-LBPort
                                        
										
										false
										false
										
									

									

										-Credential
                                        
										
										false
										false
										
									

									

										-Shutdown
                                        
										
										false
										false
										
									

									

										-Force
                                        
										
										false
										false
										
									

									

										-SleepTime
                                        
										
										false
										false
										
									

									

										-Cycles
                                        
										
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-WhatIf
                                        wi
										
										false
										false
										
									

									

										-Confirm
                                        cf
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										
										false
										false
										
									

									

										-SubjectCN
                                        
										
										false
										false
										
									

								
							

						
				
				

				

					

						
 Restore-Certificate 

						
WARNING: This function is deprecated. Use the following command instead:
Restore-TlsCertificate

						
WARNING: This function is deprecated. Use the following command instead:
Restore-TlsCertificate

					

                        

                        
 Syntax 

                        

						

                            


Restore-Certificate -Password <String> [-Path <String>] -Type <String> [-LoadBalancer <String>] [-LBPort <Int32>] 
[-Credential <Object>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Restore-Certificate -Password <String> [-Path <String>] -Type <String> [-LoadBalancer <String>] [-LBPort <Int32>] 
[-CertificateStoreLocation <String>] [-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable 
<String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-Password
                                        
										
										true
										false
										
									

									

										-Path
                                        
										
										false
										false
										
									

									

										-Type
                                        
										
										true
										false
										
									

									

										-LoadBalancer
                                        
										
										false
										false
										
									

									

										-LBPort
                                        
										
										false
										false
										
									

									

										-Credential
                                        
										
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										
										false
										false
										
									

									

										-SubjectCN
                                        
										
										false
										false
										
									

								
							

						
				
				

				

					

						
 Restore-LmConfiguration 

						
Allows you to restore the LoadMaster using a backup file previously saved.

						
Allows you to restore the LoadMaster using a backup file previously saved.

					

                        

                        
 Syntax 

                        

						

                            


Restore-LmConfiguration -Path <String> -Type <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Restore-LmConfiguration -Path <String> -Type <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation 
<String>] [-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-Path
                                        
										The local path to the backup file.
										true
										false
										
									

									

										-Type
                                        
										The type of information to restore. Valid values are:
Base
Base + VS
Base + Geo
VS
VS + Geo
Geo
SSO/LDAP
All		
										true
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Restore-LmConfiguration -Path C:\backups\LMBackups_2013_11_04.17_43 -Type Base

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.

                            

						

                        
Top of page
				

				

					

						
 Restore-LoadBalancer 

						
WARNING: This function is deprecated. Use the following command instead:
Restore-LmConfiguration

						
WARNING: This function is deprecated. Use the following command instead:
Restore-LmConfiguration

					

                        

                        
 Syntax 

                        

						

                            


Restore-LoadBalancer -Path <String> -Type <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Restore-LoadBalancer -Path <String> -Type <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation 
<String>] [-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-Path
                                        
										
										true
										false
										
									

									

										-Type
                                        
										
										true
										false
										
									

									

										-LoadBalancer
                                        
										
										false
										false
										
									

									

										-LBPort
                                        
										
										false
										false
										
									

									

										-Credential
                                        
										
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										
										false
										false
										
									

									

										-SubjectCN
                                        
										
										false
										false
										
									

								
							

						
				
				

				

					

						
 Restore-Patch 

						
WARNING: This function is deprecated. Use the following command instead:
Uninstall-LmPatch

						
WARNING: This function is deprecated. Use the following command instead:
Uninstall-LmPatch

					

                        

                        
 Syntax 

                        

						

                            


Restore-Patch [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction <ActionPreference>] 
[-InformationVariable <String>] [<CommonParameters>]

Restore-Patch [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN <String>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-LoadBalancer
                                        
										
										false
										false
										
									

									

										-LBPort
                                        
										
										false
										false
										
									

									

										-Credential
                                        
										
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										
										false
										false
										
									

									

										-SubjectCN
                                        
										
										false
										false
										
									

								
							

						
				
				

				

					

						
 Restore-TlsCertificate 

						
Allows you to restore an existing certificate to the LoadMaster.

						
Allows you to restore an existing certificate to the LoadMaster.

					

                        

                        
 Syntax 

                        

						

                            


Restore-TlsCertificate -Password <String> [-Path <String>] -Type <String> [-LoadBalancer <String>] [-LBPort <Int32>] 
[-Credential <Object>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Restore-TlsCertificate -Password <String> [-Path <String>] -Type <String> [-LoadBalancer <String>] [-LBPort <Int32>] 
[-CertificateStoreLocation <String>] [-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable 
<String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-Password
                                        
										The password that was used to backup the certificate, if needed.
										true
										false
										
									

									

										-Path
                                        
										The local path to the certificate backup file.
										false
										false
										
									

									

										-Type
                                        
										The type of certificate to restore from the backup file. This parameter is required.
This parameter has three possible values:
   - Full - All Virtual Service and intermediate certificates
   - Third - Intermediate certificates only
   - Vs - Virtual Service certificates only		
										true
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Restore-TlsCertificate -Password password -Type Full -Path C:\Certificates\CertBackup

							    
Example Output:
ok

                            

						

                        
Top of page
				

				

					

						
 Set-AdaptiveCheck 

						
WARNING: This function is deprecated. Use the following command instead:
Set-AdcAdaptiveHealthCheck

						
WARNING: This function is deprecated. Use the following command instead:
Set-AdcAdaptiveHealthCheck

					

                        

                        
 Syntax 

                        

						

                            


Set-AdaptiveCheck [-AdaptiveURL <String>] [-AdaptivePort <Int32>] [-AdaptiveInterval <Int32>] [-MinPercent <Int16>] 
[-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction <ActionPreference>] 
[-InformationVariable <String>] [<CommonParameters>]

Set-AdaptiveCheck [-AdaptiveURL <String>] [-AdaptivePort <Int32>] [-AdaptiveInterval <Int32>] [-MinPercent <Int16>] 
[-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN <String>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-AdaptiveURL
                                        
										
										false
										false
										
									

									

										-AdaptivePort
                                        
										
										false
										false
										
									

									

										-AdaptiveInterval
                                        
										
										false
										false
										
									

									

										-MinPercent
                                        
										
										false
										false
										
									

									

										-LoadBalancer
                                        
										
										false
										false
										
									

									

										-LBPort
                                        
										
										false
										false
										
									

									

										-Credential
                                        
										
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										
										false
										false
										
									

									

										-SubjectCN
                                        
										
										false
										false
										
									

								
							

						
				
				

				

					

						
 Set-AdcAdaptiveHealthCheck 

						
Allows you to set the values of the Adaptive Health Checking options.

						
Allows you to set the values of the Adaptive Health Checking options.

					

                        

                        
 Syntax 

                        

						

                            


Set-AdcAdaptiveHealthCheck [-AdaptiveURL <String>] [-AdaptivePort <Int32>] [-AdaptiveInterval <Int32>] [-MinPercent 
<Int16>] [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction <ActionPreference>] 
[-InformationVariable <String>] [<CommonParameters>]

Set-AdcAdaptiveHealthCheck [-AdaptiveURL <String>] [-AdaptivePort <Int32>] [-AdaptiveInterval <Int32>] [-MinPercent 
<Int16>] [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN <String>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-AdaptiveURL
                                        
										The URL on the Real Servers which will return the current load of the Real Server.
										false
										false
										
									

									

										-AdaptivePort
                                        
										The port on the Real Servers used to access the URL containing the current load of the Real Server.
										false
										false
										
									

									

										-AdaptiveInterval
                                        
										When using adaptive scheduling, the Real Servers are polled to retrieve their loading values. How often this occurs can be 
specified here.		
										false
										false
										
									

									

										-MinPercent
                                        
										The minimum load of the Real Server, below which the Real Server is said to be idle.
										false
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Set-AdcAdaptiveHealthCheck -AdaptiveURL www.example.com

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.
AdaptiveURL      : www.example.com
AdaptivePort     : 80
AdaptiveInterval : 7
MinPercent       : 5

                            

						

                        
Top of page
				

				

					

						
 Set-AdcContentRule 

						
Allows you to set a rule in the LoadMaster.

						
Allows you to set a rule in the LoadMaster. Including the Confirm parameter opens a confirmation dialog.

					

                        

                        
 Syntax 

                        

						

                            


Set-AdcContentRule -RuleName <String> [-MatchType <String>] [-IncHost <Boolean>] [-NoCase <Boolean>] [-Negate <Boolean>] 
[-IncQuery <Boolean>] [-Header <String>] [-Pattern <String>] [-Replacement <String>] [-Type <Int32>] [-MustFail <Int32>] 
[-OnlyOnFlag <Int32>] [-SetFlagOnMatch <Int32>] [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Set-AdcContentRule -RuleName <String> [-MatchType <String>] [-IncHost <Boolean>] [-NoCase <Boolean>] [-Negate <Boolean>] 
[-IncQuery <Boolean>] [-Header <String>] [-Pattern <String>] [-Replacement <String>] [-Type <Int32>] [-MustFail <Int32>] 
[-OnlyOnFlag <Int32>] [-SetFlagOnMatch <Int32>] [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation 
<String>] [-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-RuleName
                                        
										The name of the rule.
										true
										false
										
									

									

										-MatchType
                                        
										Specifies whether the rule matches on a regular expression (regex), prefix, or postfix. This parameter defaults to regex, 
but will also accept prefix or postfix.		
										false
										false
										
									

									

										-IncHost
                                        
										Specifies whether to include the host in the URL.
										false
										false
										
									

									

										-NoCase
                                        
										Specifies whether to ignore case/capitalization.
										false
										false
										
									

									

										-Negate
                                        
										Specifies whether to invert the case of the match.
										false
										false
										
									

									

										-IncQuery
                                        
										Append the query string to the URI before performing a match.
										false
										false
										
									

									

										-Header
                                        
										Specifies the header that a match should be performed on. Set this to body to match on the body of a request.
										false
										false
										
									

									

										-Pattern
                                        
										Specifies the pattern to search for.
										false
										false
										
									

									

										-Replacement
                                        
										Specifies the replacement string for the pattern.
										false
										false
										
									

									

										-Type
                                        
										The type of content rule:
0 - Content Matching
1 - Add Header
2 - Delete Header
3 - Replace Header
4 - Modify URL
5 - Replace String in Response Body
The other parameters available for the Set-AdcContentRule command depend on the "type" of content rule being added.		
										false
										false
										
									

									

										-MustFail
                                        
										If this rule is matched, then always fail to connect.
0 - Disabled (do not fail to connect)
1 - Enabled (fail to connect)		
										false
										false
										
									

									

										-OnlyOnFlag
                                        
										Only try to execute this rule if the specified flag is set by another rule (the OnlyOnFlag parameter is used in conjunction 
with the SetFlagOnMatch parameter).
Using the OnlyOnFlag and SetFlagOnMatch parameters, it is possible to make rules dependent on each other, that is, only 
execute a particular rule if another rule has been successfully matched ('chaining' rules). For more detailed instructions 
on ‘chaining’ rules, please refer to the Content Rules, Feature Description document on the Kemp Documentation Page: 
https://kemptechnologies.com/loadmaster-documentation/
Valid values: 0-9		
										false
										false
										
									

									

										-SetFlagOnMatch
                                        
										SetFlagOnMatch:
If the rule is successfully matched, set the specified flag. Using the OnlyOnFlag and SetFlagOnMatch parameters, it is 
possible to make rules dependent on each other, that is, only execute a particular rule if another rule has been 
successfully matched. For more detailed instructions on ‘chaining’ rules, please refer to the Content Rules, Feature 
Description document on the Kemp Documentation Page: https://kemptechnologies.com/loadmaster-documentation/.
Valid values: 0-9		
										false
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-IncQueryfalse
                                        
										Append the query string to the URI before performing a match.
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Set-AdcContentRule -Name TestRule1 -Negate $True -NoCase $False -Pattern /^example$/

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.

                            

						

                        
Top of page
				

				

					

						
 Set-AdcL7Configuration 

						
Allows you to set the values of Layer 7 Configuration options.

						
Allows you to set the values of Layer 7 Configuration options.

					

                        

                        
 Syntax 

                        

						

                            


Set-AdcL7Configuration [-ScalingOver64KConnections <Boolean>] [-AlwaysCheckPersist <String>] [-AddPortToActiveCookie 
<Boolean>] [-RFCConform <Boolean>] [-CloseOnError <Boolean>] [-AddViaHeaderInCacheResponses <Boolean>] [-RSAreLocal 
<Boolean>] [-DropOnRSFail <Boolean>] [-DropAtDrainEnd <Boolean>] [-Transparent <Boolean>] [-L7AuthTimeoutSecs <Int16>] 
[-L7ClientTokenTimeoutSecs <Int16>] [-L7ConnectionDrainTimeoutSecs <Int32>] [-AdditionalL7Header <String>] 
[-OneHundredContinueHandling <String>] [-AllowEmptyPosts <Boolean>] [-AllowEmptyHttpHeaders <Boolean>] 
[-ForceCompleteRSMatch <Boolean>] [-SlowStart <Int16>] [-ShareSubVSPersistance <Boolean>] [-LoadBalancer <String>] [-LBPort 
<Int32>] [-Credential <Object>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Set-AdcL7Configuration [-ScalingOver64KConnections <Boolean>] [-AlwaysCheckPersist <String>] [-AddPortToActiveCookie 
<Boolean>] [-RFCConform <Boolean>] [-CloseOnError <Boolean>] [-AddViaHeaderInCacheResponses <Boolean>] [-RSAreLocal 
<Boolean>] [-DropOnRSFail <Boolean>] [-DropAtDrainEnd <Boolean>] [-Transparent <Boolean>] [-L7AuthTimeoutSecs <Int16>] 
[-L7ClientTokenTimeoutSecs <Int16>] [-L7ConnectionDrainTimeoutSecs <Int32>] [-AdditionalL7Header <String>] 
[-OneHundredContinueHandling <String>] [-AllowEmptyPosts <Boolean>] [-AllowEmptyHttpHeaders <Boolean>] 
[-ForceCompleteRSMatch <Boolean>] [-SlowStart <Int16>] [-ShareSubVSPersistance <Boolean>] [-LoadBalancer <String>] [-LBPort 
<Int32>] [-CertificateStoreLocation <String>] [-SubjectCN <String>] [-InformationAction <ActionPreference>] 
[-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-ScalingOver64KConnections
                                        
										Under very high load situations, Port Exhaustion can occur. Enabling this option will allow the setting of Alternate Source 
Addresses which can be used to expand the number of local ports available.


If more than 64K concurrent connections are required, enable the Allow Connection Scaling over 64K Connections option and 
set the Virtual Service IP as the alternate address in the Alternate Source Addresses input field. This allows each Virtual 
Service to have its own pool of source ports.


Transparent Virtual Services are capped at 64K concurrent connections. This limit is on a per Virtual Service basis.


If, after selecting this option, you set some Alternate Source Addresses, you will not be able to disable the Allow 
connection scaling over 64K Connections option.		
										false
										false
										
									

									

										-AlwaysCheckPersist
                                        
										By default, the L7 module only checks persist on the first request of a HTTP/1.1 connection. Enabling this option will 
check the persist on every request. When Accept Changes is selected, all persistence changes are saved, even in the middle 
of a connection.
Valid values are:
No
Yes
Yes - Accept Changes		
										false
										false
										
									

									

										-AddPortToActiveCookie
                                        
										When using the LoadMaster behind a NATing gateway, all client addresses are the same. To create individual cookies the 
remote port can also be added to the cookie. Enabling this option when not needed wastes resources. Valid values are:
0 - Disable
1 - Enable		
										false
										false
										
									

									

										-RFCConform
                                        
										By default, the LoadMaster conforms to the RFC when parsing HTTP headers. Disabling this will allow interworking with some 
broken browsers. Valid values:
0 - Disable
1 - Enable		
										false
										false
										
									

									

										-CloseOnError
                                        
										When enabled, the LoadMaster will always close the client connection when it sends back an error response. For Example, 
this changes the behaviour of the LoadMaster when sending back a 304 File not changed message after receiving an 
If-Modified-Since HTTP header.		
										false
										false
										
									

									

										-AddViaHeaderInCacheResponses
                                        
										When enabled, a VIA header field will be added to all cache responses. The Virtual Service address will be the address 
used. Valid values are:
0 - Disable
1 - Enable		
										false
										false
										
									

									

										-RSAreLocal
                                        
										When checking to see if a client is on the local subnet, also check to see if the client is actually a Real Server.
										false
										false
										
									

									

										-DropOnRSFail
                                        
										By default, existing connections are not closed if a Real Server fails. Enabling this feature causes all connections to be 
immediately dropped on Real Server failure. Valid values:
0 - Disable
1 - Enable		
										false
										false
										
									

									

										-DropAtDrainEnd
                                        
										If enabled, all open connections to disabled Real Servers will be dropped at the end of the Real Servers Drain Stop Time or 
immediately if there are no Persist entries associated with the Real Server.		
										false
										false
										
									

									

										-Transparent
                                        
										Globally enable or disable the transparent handling of connections using the L7 subsystem. L4 connections are ALWAYS 
handled transparently.		
										false
										false
										
									

									

										-L7AuthTimeoutSecs
                                        
										The duration (in seconds) that a connection remains open for while authentication is ongoing. This value can be between 30 
and 300.		
										false
										false
										
									

									

										-L7ClientTokenTimeoutSecs
                                        
										The duration (in seconds) to wait for the client token while the process of authentication is ongoing (used for RSA SecurID 
and RADIUS authentication). The default value for this parameter is 120. The range for this parameter is 60-300.		
										false
										false
										
									

									

										-L7ConnectionDrainTimeoutSecs
                                        
										If enabled, all open connections to disabled Real Servers will be dropped at the end of the Real Servers Drain Stop Time OR 
immediately if there are no Persist entries associated with the Real Server. Valid values are:
0 - Disable
1 - Enable		
										false
										false
										
									

									

										-AdditionalL7Header
                                        
										This option (which is only available when L7 Transparency is disabled), allows the addition of either X-ClientSide or 
X-Forwarded For to the HTTP header. The default value is X-Forwarded-For.
0 - X-ClientSide
1 - X-Forwarded-For
2 - None		
										false
										false
										
									

									

										-OneHundredContinueHandling
                                        
										Determines how 100-Continue Handling messages are handled. The available options are:
 - RFC-2616 Compliant (0): conforms with the behavior as outlined in RFC-2616
 - Require 100-Continue (1): forces the LoadMaster to wait for the 100-Continue message
 - RFC-7231 Compliant (2): ensures the LoadMaster does not wait for 100-Continue messages. This is the default value.
Modifying how 100 Continue messages are handled by the system requires an understanding of the relevant technologies as 
described in the RFCs listed above. It is recommended that you speak with a Kemp Technical Support engineer before making 
changes to these settings.		
										false
										false
										
									

									

										-AllowEmptyPosts
                                        
										By default the LoadMaster blocks POSTs that do not contain a Content-Length or Transfer-Encoding header to indicate the 
length of the requests payload. When this parameter is set to true, such requests are assumed to have no payload data and 
are therefore not rejected.		
										false
										false
										
									

									

										-AllowEmptyHttpHeaders
                                        
										By default, if the LoadMaster is processing HTTP headers it ignores HTTP headers that have empty content. This can break 
some SOAP services, even though it is against the HTTP RFCs. Setting this option allows these empty headers through. Valid 
values are:
0 - Disable
1 - Enable		
										false
										false
										
									

									

										-ForceCompleteRSMatch
                                        
										By default, when the LoadMaster is trying to locate a Real Server for use with content switching, it tries to use the same 
Real Server as currently selected, even if the port is not the same. Enabling this parameter forces the port to also be 
compared. Valid values are:
0 - Disable
1 - Enable		
										false
										false
										
									

									

										-SlowStart
                                        
										When using the Least Connection (or Weighted Least Connection) scheduling method, specify the time (in seconds) over which 
the load to a Real Server which has just come online will be throttled.		
										false
										false
										
									

									

										-ShareSubVSPersistance
                                        
										By default, each SubVS has an independent persistence table. Enabling this parameter will allow the SubVS to share this 
information. Valid values are:
0 - Disable
1 - Enable		
										false
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-AddCookiePort
                                        
										When using the LoadMaster behind a NATing gateway, all client addresses are the same. To create individual cookies the 
remote port can also be added to the cookie. Enabling this option when not needed wastes resources.		
										false
										false
										
									

									

										-AddVia
                                        
										Specify which headers to be added to HTTP requests. X-ClientSide and X-Forwarded-For are only added to non-transparent 
connections.
   0 - Legacy Operation(X-Forwarded-For)
   1 - X-Forwarded-For (+ Via)
   2 - None
   3 - X-ClientSide (+ Via)
   4 - X-ClientSide (No Via)
   5 - X-Forwarded-For (No Via)
   6 - Via Only		
										false
										false
										
									

									

										-AlwaysPersist
                                        
										This parameter also accepts no and yes as valid values. No and Yes correspond to 0 and 1 respectively.
										false
										false
										
									

									

										-AuthTimeout
                                        
										The duration (in seconds) that a connection remains open for while authentication is ongoing. This value can be between 30 
and 300.		
										false
										false
										
									

									

										-ClientTokenTimeout
                                        
										The duration (in seconds) to wait for the client token while the process of authentication is ongoing (used for RSA SecurID 
and RADIUS authentication). The default value for this parameter is 120.		
										false
										false
										
									

									

										-DropOnFail
                                        
										By default, existing connections are not closed if a Real Server fails. Enabling this feature causes all connections to be 
immediately dropped on Real Server failure.		
										false
										false
										
									

									

										-Expect100
                                        
										By default, the L7 module only waits for 100-Continue replies if it sees an Expect-100 header, use RFC-2616 Compliant. If 
the system will always wait for 100 Continue messages, use Require 100-Continue. If the client will always send the POST 
data even if a 100 Continue message is not sent, use RFC-7231 Compliant instead.		
										false
										false
										
									

									

										-RFConform
                                        
										By default, the LoadMaster conforms to the RFC when parsing HTTP headers. Disabling this will allow interworking with some 
broken browsers.		
										false
										false
										
									

									

										-LocalBind
                                        
										In very high load situations, local port exhaustion can occur. Enabling this option allows the setting of alternate source 
addresses. This can be used to expand the number of available local ports.		
										false
										false
										
									

									

										-AddForwardHeader
                                        
										This option, only available when L7 Transparency is disabled, allows the addition of either X-ClientSide or X-Forwarded For 
to the HTTP header.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Set-AdcL7Configuration -OneHundredContinueHandling "RFC-2616 Compliant"

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed; Data=}
Return Code..: 200
Response.....: Command successfully executed
Data field...: @{AdcL7Configuration=}
Param........: @{ScalingOver64KConnections=no; AlwaysCheckPersist=Yes - Accept Changes; AddPortToActiveCookie=no; 
RFCConform=yes; CloseOnError=no; AddVi
aHeaderInCacheResponses=no; RSAreLocal=no; DropOnRSFail=no; DropAtDrainEnd=no; L7AuthTimeoutSecs=30; 
L7ClientTokenTimeoutSecs=120; L7ConnectionDrainTime
outSecs=300; AdditionalL7Header=X-ClientSide; OneHundredContinueHandling=RFC-2616 Compliant; AllowEmptyPosts=no; 
AllowEmptyHttpHeaders=no; ForceComplete
RSMatch=no; SlowStart=0; ShareSubVSPersistance=no}
ScalingOver64KConnections    : no
AlwaysCheckPersist           : Yes - Accept Changes
AddPortToActiveCookie        : no
RFCConform                   : yes
CloseOnError                 : no
AddViaHeaderInCacheResponses : no
RSAreLocal                   : no
DropOnRSFail                 : no
DropAtDrainEnd               : no
L7AuthTimeoutSecs            : 30
L7ClientTokenTimeoutSecs     : 120
L7ConnectionDrainTimeoutSecs : 300
AdditionalL7Header           : X-ClientSide
OneHundredContinueHandling   : RFC-2616 Compliant
AllowEmptyPosts              : no
AllowEmptyHttpHeaders        : no
ForceCompleteRSMatch         : no
SlowStart                    : 0
ShareSubVSPersistance        : no

                            

						

                        
Top of page
				

				

					

						
 Set-AdcL7LogInsightSplitConfiguration 

						
Allows you to set the value of the log split interval.

						
Allows you to set the value of the log split interval.

					

                        

                        
 Syntax 

                        

						

                            


Set-AdcL7LogInsightSplitConfiguration -logsplitinterval <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential 
<Object>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Set-AdcL7LogInsightSplitConfiguration -logsplitinterval <String> [-LoadBalancer <String>] [-LBPort <Int32>] 
[-CertificateStoreLocation <String>] [-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable 
<String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-logsplitinterval
                                        
										When using Log Insight Scheduling this is the number of messages that are received on a connection before the stream is 
rescheduled. The default value is 10. The range is 1-100.		
										true
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-logsplit
                                        
										This value controls how many syslog messages should be sent to each server in the pool before moving to the next server.
										true
										false
										
									

								
							

						
				
						

                            

                                
 Note 

                            

							
This command is only relevant for LoadMasters with the Log Insight Add-On Pack installed.

						

                        

                            
 Examples 

                        

						

                            

							    Example

Set-AdcL7LogInsightSplitConfiguration -logsplit 20

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed; Data=}
Return Code..: 200
Response.....: Command successfully executed
Data field...: @{logsplitinterval=20}

                            

						

                        
Top of page
				

				

					

						
 Set-AdcRealServer 

						
Configure options on a configured Real Server.

						
Modifies the settings for a Real Server that is already configured.

					

                        

                        
 Syntax 

                        

						

                            


Set-AdcRealServer [-VirtualService <String>] [-VSPort <Int32>] [-VSProtocol <String>] [-VSIndex <Int32>] [-RealServer 
<String>] [-RealServerPort <Int32>] [-RSIndex <Int32>] [-NewPort <Int32>] [-Weight <Int32>] [-Forward <String>] [-Enable 
<Boolean>] [-Limit <Int64>] [-Critical <Boolean>] [-Follow <Int32>] [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential 
<Object>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Set-AdcRealServer [-VirtualService <String>] [-VSPort <Int32>] [-VSProtocol <String>] [-VSIndex <Int32>] [-RealServer 
<String>] [-RealServerPort <Int32>] [-RSIndex <Int32>] [-NewPort <Int32>] [-Weight <Int32>] [-Forward <String>] [-Enable 
<Boolean>] [-Limit <Int64>] [-Critical <Boolean>] [-Follow <Int32>] [-LoadBalancer <String>] [-LBPort <Int32>] 
[-CertificateStoreLocation <String>] [-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable 
<String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-VirtualService
                                        
										The IP address of the Virtual Service.
										false
										false
										
									

									

										-VSPort
                                        
										The port of the relevant Virtual Service.
										false
										false
										
									

									

										-VSProtocol
                                        
										The protocol of the relevant Virtual Service.
										false
										false
										
									

									

										-VSIndex
                                        
										The index number of the Virtual Service or SubVS. To retrieve the VSIndex, run the Get-VirtualService command.
										false
										false
										
									

									

										-RealServer
                                        
										The IP address that the Real Server being defined listens on.
										false
										false
										
									

									

										-RealServerPort
                                        
										The port that the Real Server will be listening on.
										false
										false
										
									

									

										-RSIndex
                                        
										The index number of the Real Server to be modified. To retrieve the Real Server index, run the Get-VirtualService command.
If modifying the Real Server-specific parameters of a SubVS, such as critical, weight and limit, specify the RS index of 
the SubVS along with the Virtual Service parameters of the parent Virtual Service.		
										false
										false
										
									

									

										-NewPort
                                        
										Used to change the Real Server port to a new value.
										false
										false
										
									

									

										-Weight
                                        
										The Real Server's weight. This is weight of the Real Server, as used by the Weighted Round Robin, Weighted Least Connection 
and Adaptive scheduling methods. The default initial value for the weight is 1000, the maximum is 65535 and the minimum is 
1.		
										false
										false
										
									

									

										-Forward
                                        
										Either NAT (Network Address Translation) or Route (Direct) forwarding. The available options are dependent on the other 
modes configured for the service.		
										false
										false
										
									

									

										-Enable
                                        
										Specifies if the Real Server is enabled or disabled. Pass in a value of TRUE ($true) for enabled, and FALSE ($false) for 
disabled.		
										false
										false
										
									

									

										-Limit
                                        
										The maximum number of open connections that a Real Server will accept before it is taken out of the rotation. This is only 
available for Layer 7 traffic.		
										false
										false
										
									

									

										-Critical
                                        
										True or false to indicate whether this Real Server is required for the Virtual Service to be available.
										false
										false
										
									

									

										-Follow
                                        
										Specify what Real Server the health check is based on by setting this parameter to the RsIndex of the Real Server to be 
followed. This can either be set to the RsIndex of the same Real Server in order to health check based on that particular 
Real Server status, or another Real Server can be specified. For example – if Real Server 1 is down, any Real Servers which 
have their health check based on Real Server 1 will also be marked as down, regardless of their actual Real Server status.		
										false
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-Port
                                        
										The port that the Virtual Service is listening on.
										false
										false
										
									

									

										-Protocol
                                        
										Specify if the service is using TCP or UDP protocols.
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Set-AdcRealServer -Port 80 -Protocol tcp -RealServer 10.11.0.29 -RealServerPort 80 -VirtualService 10.11.0.199 -Enable $True -Forward route -Limit 100 -Weight 2000

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.

                            

						

                        
Top of page
				

				

					

						
 Set-AdcServiceHealth 

						
Allows you to set the values of the Service Check options.

						
Allows you to set the values of the Service Check options.

					

                        

                        
 Syntax 

                        

						

                            


Set-AdcServiceHealth [-CheckInterval <Int16>] [-ConnectTimeout <Int16>] [-RetryCount <Int16>] [-LoadBalancer <String>] 
[-LBPort <Int32>] [-Credential <Object>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] 
[<CommonParameters>]

Set-AdcServiceHealth [-CheckInterval <Int16>] [-ConnectTimeout <Int16>] [-RetryCount <Int16>] [-LoadBalancer <String>] 
[-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN <String>] [-InformationAction <ActionPreference>] 
[-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-CheckInterval
                                        
										Defined in seconds, this is the delay between health checks. This includes clusters and FQDNs.
Recommended and default value: 9 seconds
Valid values range from the <mininterval> (9) to the <maxinterval> (901).
The <mininterval> is RetryCount * ConnectTimeout  + 1, that is, a value of 9 by default.
The <maxinterval> is 901 [because that is what 60 (maximum Timeout) * 15 (maximum RetryCount) + 1 is]. 
You can manually set the CheckInterval to up to 120 seconds. The CheckInterval value may go above 120 if the ConnectTimeout 
and RetryCount parameters are configured with high enough values.
If the CheckInterval is above 120 seconds, you must adjust the ConnectTimeout and RetryCount values to modify the 
CheckInterval.		
										false
										false
										
									

									

										-ConnectTimeout
                                        
										Defined in seconds, this is the allowed maximum wait time for a reply to a health check.
Range: 4-60		
										false
										false
										
									

									

										-RetryCount
                                        
										This is the consecutive number of times in which a health check must fail before it is marked down and removed from the 
load balancing pool.
Range: 2-15		
										false
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Set-AdcServiceHealth -RetryCount 3 -RetryInterval 10

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.
Data field...: @{AdcServiceHealth=}
CheckInterval     : 121
ConnectionTimeout : 60
RetryCount        : 2

                            

						

                        
Top of page
				

				

					

						
 Set-AdcSubVirtualService 

						
Configure a SubVS.

						
This command enables you to set specific settings on a SubVS.

					

                        

                        
 Syntax 

                        

						

                            


Set-AdcSubVirtualService -SubVSIndex <Int32> [-AddVia <Int16>] [-CheckType <String>] [-CheckHost <String>] [-CheckPattern 
<String>] [-CheckUrl <String>] [-CheckHeaders <String>] [-LdapEndpoint <String>] [-MatchLen <String>] [-CheckUse1_1 
<Int32>] [-CheckPort <Int32>] [-EnhancedHealthChecks <Boolean>] [-RsMinimum <Int32>] [-Cookie <String>] [-Enable <Boolean>] 
[-ErrorCode <String>] [-ErrorUrl <String>] [-PortFollow <Int32>] [-ForceL7 <Boolean>] [-Idletime <Int32>] 
[-LocalBindAddresses <String[]>] [-VSType <String>] [-Nickname <String>] [-Persist <String>] [-PersistTimeout <Int32>] 
[-QueryTag <String>] [-Schedule <String>] [-ServerInit <Int16>] [-StandByAddr <String>] [-StandByPort <String>] 
[-TransactionLimit <Int32>] [-Transparent <Boolean>] [-SubnetOriginating <Boolean>] [-QoS <String>] [-CheckUseGet <Int32>] 
[-Verify <Int16>] [-ExtraHdrKey <String>] [-ExtraHdrValue <String>] [-AllowedHosts <String>] [-AllowedDirectories <String>] 
[-ExcludedDirectories <String>] [-AllowedGroups <String>] [-GroupSIDs <String>] [-SteeringGroups <String>] 
[-IncludeNestedGroups <Boolean>] [-DisplayPubPriv <Boolean>] [-DisablePasswordForm <Boolean>] [-Domain <String>] 
[-AltDomains <String>] [-Logoff <String>] [-ESPLogs <Int16>] [-SMTPAllowedDomains <String>] [-ESPEnabled <Boolean>] 
[-UserPwdChangeUrl <String>] [-UserPwdChangeMsg <String>] [-SecurityHeaderOptions <Int16>] [-InputAuthMode <Int16>] 
[-OutConf <String>] [-OutputAuthMode <Int16>] [-StartTLSMode <Int16>] [-MultiConnect <Boolean>] [-SingleSignOnDir <String>] 
[-OCSPVerify <String>] [-FollowVSID <Int32>] [-TlsType <Int32>] [-CheckPostData <String>] [-CheckCodes <String>] 
[-PreProcPrecedence <String>] [-PreProcPrecedencePos <Int16>] [-RequestPrecedence <String>] [-RequestPrecedencePos <Int16>] 
[-ResponsePrecedence <String>] [-ResponsePrecedencePos <Int16>] [-RsRulePrecedence <String>] [-RsRulePrecedencePos <Int16>] 
[-NeedHostName <Boolean>] [-CopyHdrFrom <String>] [-CopyHdrTo <String>] [-ServerFbaPath <String>] [-ServerFbaPost <String>] 
[-AddAuthHeader <String>] [-Intercept <Boolean>] [-InterceptOpts <String>] [-InterceptRules <String>] 
[-InterceptPostOtherContentTypes <String>] [-AlertThreshold <Int32>] [-Weight <Int32>] [-Limit <Int64>] [-Critical 
<Boolean>] [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction <ActionPreference>] 
[-InformationVariable <String>] [<CommonParameters>]

Set-AdcSubVirtualService -SubVSIndex <Int32> [-AddVia <Int16>] [-CheckType <String>] [-CheckHost <String>] [-CheckPattern 
<String>] [-CheckUrl <String>] [-CheckHeaders <String>] [-LdapEndpoint <String>] [-MatchLen <String>] [-CheckUse1_1 
<Int32>] [-CheckPort <Int32>] [-EnhancedHealthChecks <Boolean>] [-RsMinimum <Int32>] [-Cookie <String>] [-Enable <Boolean>] 
[-ErrorCode <String>] [-ErrorUrl <String>] [-PortFollow <Int32>] [-ForceL7 <Boolean>] [-Idletime <Int32>] 
[-LocalBindAddresses <String[]>] [-VSType <String>] [-Nickname <String>] [-Persist <String>] [-PersistTimeout <Int32>] 
[-QueryTag <String>] [-Schedule <String>] [-ServerInit <Int16>] [-StandByAddr <String>] [-StandByPort <String>] 
[-TransactionLimit <Int32>] [-Transparent <Boolean>] [-SubnetOriginating <Boolean>] [-QoS <String>] [-CheckUseGet <Int32>] 
[-Verify <Int16>] [-ExtraHdrKey <String>] [-ExtraHdrValue <String>] [-AllowedHosts <String>] [-AllowedDirectories <String>] 
[-ExcludedDirectories <String>] [-AllowedGroups <String>] [-GroupSIDs <String>] [-SteeringGroups <String>] 
[-IncludeNestedGroups <Boolean>] [-DisplayPubPriv <Boolean>] [-DisablePasswordForm <Boolean>] [-Domain <String>] 
[-AltDomains <String>] [-Logoff <String>] [-ESPLogs <Int16>] [-SMTPAllowedDomains <String>] [-ESPEnabled <Boolean>] 
[-UserPwdChangeUrl <String>] [-UserPwdChangeMsg <String>] [-SecurityHeaderOptions <Int16>] [-InputAuthMode <Int16>] 
[-OutConf <String>] [-OutputAuthMode <Int16>] [-StartTLSMode <Int16>] [-MultiConnect <Boolean>] [-SingleSignOnDir <String>] 
[-OCSPVerify <String>] [-FollowVSID <Int32>] [-TlsType <Int32>] [-CheckPostData <String>] [-CheckCodes <String>] 
[-PreProcPrecedence <String>] [-PreProcPrecedencePos <Int16>] [-RequestPrecedence <String>] [-RequestPrecedencePos <Int16>] 
[-ResponsePrecedence <String>] [-ResponsePrecedencePos <Int16>] [-RsRulePrecedence <String>] [-RsRulePrecedencePos <Int16>] 
[-NeedHostName <Boolean>] [-CopyHdrFrom <String>] [-CopyHdrTo <String>] [-ServerFbaPath <String>] [-ServerFbaPost <String>] 
[-AddAuthHeader <String>] [-Intercept <Boolean>] [-InterceptOpts <String>] [-InterceptRules <String>] 
[-InterceptPostOtherContentTypes <String>] [-AlertThreshold <Int32>] [-Weight <Int32>] [-Limit <Int64>] [-Critical 
<Boolean>] [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN <String>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-SubVSIndex
                                        
										The ID number of the SubVS to configure.
										true
										false
										
									

									

										-AddVia
                                        
										Specifies which headers should be added to the HTTP stream. The parameter takes the following arguments:
   0 = Legacy Operation
   1 = X-Forwarded-For
   2 = None
   3 = X-Client-Side
   4 = X-Client-Side No Via
   5 = X-Forwarded-For No Via
   6 = Via Only		
										false
										false
										
									

									

										-CheckType
                                        
										Specifies the protocol to use to check if the service is up. Valid options are "tcp", "icmp", "https", "http", "smtp", 
"nntp", "ftp", "telnet", "pop3", 
"imap", "rdp", "ldap" or "none".		
										false
										false
										
									

									

										-CheckHost
                                        
										The address to use to check if the service is up.
										false
										false
										
									

									

										-CheckPattern
                                        
										A regular expression string that can be validate on a 200 reply to determine if the service is up.
Specify an empty value to unset CheckPattern.		
										false
										false
										
									

									

										-CheckUrl
                                        
										The URL to check if the service is up. The maximum character length for the CheckUrl parameter value is 126 characters.
										false
										false
										
									

									

										-CheckHeaders
                                        
										Specify up to four additional headers/fields which will be sent with each health check request. Separate the pairs with a 
pipe, for example; 
Host:xyc|UserAgent:prq.		
										false
										false
										
									

									

										-LdapEndpoint
                                        
										Specify the LDAP endpoint to use for health checks (if LDAP is selected as the CheckType). If LDAP is selected as the 
health check protocol, the server IP 
address (or addresses) and ports from the LDAP endpoint configuration will be used instead of the Real Server IP address 
and port.		
										false
										false
										
									

									

										-MatchLen
                                        
										This parameter is only relevant when the CheckType is set to "bdata". Specify the number of bytes to find the CheckPattern 
within.		
										false
										false
										
									

									

										-CheckUse1_1
                                        
										Specifies that the health checker use HTTP/1.1 instead of HTTP/1.0. By default, the health checker uses HTTP/1.0 when 
checking the Real Server status. Enabling CheckUse1_1 means HTTP/1.1 is used (which is more efficient).
Note: Optimization only works on HTTP (not HTTPS) connections.
0 - HTTP/1.0
1 - HTTP/1.1		
										false
										false
										
									

									

										-CheckPort
                                        
										The port to use to check if the service is up.
Specify 0 to unset CheckPort.		
										false
										false
										
									

									

										-EnhancedHealthChecks
                                        
										Enables or disables Enhanced Health Check Options for the Virtual Service.
										false
										false
										
									

									

										-RsMinimum
                                        
										Specifies the minimum number of Real Servers that are required to be active for the Virtual Service to be considered up.
										false
										false
										
									

									

										-Cookie
                                        
										Specifies a cookie name. This parameter is only relevant when the persistence mode is set to "cookie", "active-cookie", 
"cookie-src" or "active-cook-src".		
										false
										false
										
									

									

										-Enable
                                        
										Enables or disables the Virtual Service.
										false
										false
										
									

									

										-ErrorCode
                                        
										If no Real Servers are available, the LoadMaster can terminate the connection with an HTTP error code. Specify the error 
code number in this parameter.		
										false
										false
										
									

									

										-ErrorUrl
                                        
										When no Real Servers are available and an error response is sent back to the client, a redirect URL can also be specified.
										false
										false
										
									

									

										-PortFollow
                                        
										This parameter was depreciated as of 7.1-24. For LoadMasters with version 7.1-24 or higher, use the FollowVSID parameter to 
set port following.		
										false
										false
										
									

									

										-ForceL7
                                        
										Enabling ForceL7 means the Virtual Service runs at Layer 7 and not Layer 4. This may be needed for various reasons, 
including that only Layer 7 services can be non-transparent.		
										false
										false
										
									

									

										-Idletime
                                        
										Specifies the length of time (in seconds) that a connection may remain idle before it is closed. The range for this 
parameter is 0 to 86400. 0 means indefinitely.		
										false
										false
										
									

									

										-LocalBindAddresses
                                        
										Specifies a space-separated list of IP addresses. This corresponds to the Alternate Source Address in the Advanced 
Properties section of the WUI. Allow connections scaling over 64K Connections needs to be enabled in L7 Configuration for 
this feature to work.		
										false
										false
										
									

									

										-VSType
                                        
										Specifies the type of service being load balanced:
gen - Generic
http - HTTP/HTTPS
ts - Remote Terminal
tls – STARTTLS protocols
log – Log Insight		
										false
										false
										
									

									

										-Nickname
                                        
										Specifies the "friendly" name of the service. In addition to the usual alphanumeric characters, the following "special" 
characters can be used as part of the Service Name:
. @ - _


However, there must be at least one alphanumeric character before the special characters.		
										false
										false
										
									

									

										-Persist
                                        
										Specifies the type of persistence (stickiness) to be used for this Virtual Service.


The following persistence values are supported: ssl, cookie, active-cookie, cookie-src, active-cook-src, cookie-hash, 
cookie-hash-src, url, query-hash, host, header, super, super-src, src, rdp, rdp-src, rdp-sb, rdp-sb-src and none.


Note: If setting the persistence mode to an option that requires a cookie (or query-hash), the cookie parameter must also 
be set.		
										false
										false
										
									

									

										-PersistTimeout
                                        
										The length of time (in seconds) after the last connection that the LoadMaster will remember the persistence information. 
Timeout values are rounded down to an even number of minutes. Setting a value that is not a number of whole minutes results 
in the excess being ignored. Setting a value to less than 60 seconds results in a value of 0 being set, which disables 
persistency.		
										false
										false
										
									

									

										-QueryTag
                                        
										This is the query tag to be matched if the Persist type is set to query-hash.
										false
										false
										
									

									

										-Schedule
                                        
										Specifies the type of scheduling of new connections to Real Servers that is to be performed. The following values are 
supported:
rr = round robin
wrr = weighted round robin
lc = least connection
wlc = weighted least connection
fixed = fixed weighting
adaptive = resource based (adaptive)
sh = source IP hash
dl = weighted response time
sdn-adaptive = resource based (SDN adaptive)		
										false
										false
										
									

									

										-ServerInit
                                        
										Specifies one of the following values:
0 - Normal Protocols
1 - SMTP
2 - SSH
3 - Other Server Initiating
4 - IMAP4
5 - MySQL
6 - POP3		
										false
										false
										
									

									

										-StandByAddr
                                        
										Specifies the IP address of the "Sorry" server that is to be used when no other Real Servers are available. This server 
will not be health checked and is assumed to be always available.		
										false
										false
										
									

									

										-StandByPort
                                        
										Specifies the port of the "Sorry" server.
										false
										false
										
									

									

										-TransactionLimit
                                        
										This is a legacy parameter that should no longer be used. It was used previously when the SSL proxy was limited to 6K total 
connections. The transaction limit was used to limit one Virtual Service to only handle so many connections out of this 6K. 
On newer systems, where the limit is greater than 64K - this feature is no longer required.		
										false
										false
										
									

									

										-Transparent
                                        
										When using Layer 7, when this is enabled - the connection arriving at the Real Server appears to come directly from the 
client. Alternatively, the connection can be non-transparent which means that the connections at the Real Server appear to 
come from the LoadMaster.		
										false
										false
										
									

									

										-SubnetOriginating
                                        
										When transparency is not enabled, the source IP address of connections to the Real Servers is that of the Virtual Service. 
When transparency is enabled, the source IP address will be the IP address that is initiating connection to the Virtual 
Service. If the Real Server is on a subnet, and the Subnet Originating Requests option is enabled, then the subnet address 
of the LoadMaster will be used as the source IP address.		
										false
										false
										
									

									

										-QoS
                                        
										Specifies the Quality of Service. The following values are supported:
0 - Normal-Service
1 - Minimize-Cost
2 - Maximize-Reliability
4 - Maximize-Throughput
8 - Minimize-Delay		
										false
										false
										
									

									

										-CheckUseGet
                                        
										When accessing the health check URL - the system can use the HEAD, the GET or the POST method:
0 - HEAD
1 - GET
2 - POST		
										false
										false
										
									

									

										-Verify
                                        
										Specifies a verification bitmask. The valid values of the Verify parameter are as follows:
Bit 0: set this to 1 to enable detection intrusion.
Note: Bit 0 needs to be set to 1 in order to use the other two bits.
Bit 1: Determines whether to reject or drop a connection. Setting it to 1 will drop the connection.
Bit 2: Determines whether to give just warnings on bad requests or also on malicious (but not invalid) requests.
The following table lists the valid integers and the values they set the fields to when used: 
Integer Detect Malicious Requests Intrusion Handling Warnings Checkbox
0 Disabled N/A N/A
1 Enabled Drop Connection Unchecked
2 Enabled Send Reject Unchecked
3 Enabled Send Reject Unchecked
4 Enabled Drop Connection Checked
5 Enabled Drop Connection Checked
6 Enabled Send Reject Checked
7 Enabled Send Reject Checked		
										false
										false
										
									

									

										-ExtraHdrKey
                                        
										Specifies the key for the extra header to be inserted into every request sent to the Real Servers.
										false
										false
										
									

									

										-ExtraHdrValue
                                        
										Specifies the value for the extra header to be inserted into every request sent to the Real Servers.
										false
										false
										
									

									

										-AllowedHosts
                                        
										This parameter is only relevant when ESP is enabled. Specifies all the virtual hosts that can be accessed via this Virtual 
Service.		
										false
										false
										
									

									

										-AllowedDirectories
                                        
										This parameter is only relevant when ESP is enabled. Specifies all the virtual directories that can be accessed via this 
Virtual Service.		
										false
										false
										
									

									

										-ExcludedDirectories
                                        
										This parameter is only relevant when ESP is enabled. Any virtual directories specified within this field will not be 
pre-authorized on this Virtual Service and are passed directly to the relevant Real Servers.		
										false
										false
										
									

									

										-AllowedGroups
                                        
										Specifies the groups that are allowed to access this Virtual Service.
										false
										false
										
									

									

										-GroupSIDs
                                        
										Specify the group SID(s) that are allowed to access this Virtual Service. Multiple SIDs can be separating them with a 
semicolon.		
										false
										false
										
									

									

										-SteeringGroups
                                        
										Enter the Active Directory group names that will be used for steering traffic. Use a semi-colon to separate multiple group 
names. The steering group index number corresponds to the location of the group in this list.		
										false
										false
										
									

									

										-IncludeNestedGroups
                                        
										Specify if nested groups should be included in the authentication attempt.
										false
										false
										
									

									

										-DisplayPubPriv
                                        
										Display the public/private option on the login page. Based on the option the user selects on the login form, the session 
timeout value will be set to the 
value specified for either the public or private timeout.		
										false
										false
										
									

									

										-DisablePasswordForm
                                        
										Enabling this option removes the password field from the login page. This may be needed when password validation is not 
required, for example if using RSA SecurID authentication in a singular fashion.		
										false
										false
										
									

									

										-Domain
                                        
										Specifies the Single Sign On (SSO) domain in which this Virtual Service will operate.
										false
										false
										
									

									

										-AltDomains
                                        
										Specifies alternative domains to be assigned to a Virtual Service when configuring multi-domain authentication. To specify 
multiple alternative domains use a space-separated list.		
										false
										false
										
									

									

										-Logoff
                                        
										This parameter is only relevant when ESP is enabled and when the Client Authentication Mode is set to Form Based. Specify 
the string that the LoadMaster should use to detect a logout event. Multiple logoff strings can be specified by using a 
space-separated list.


If the URL to be matched contains sub-directories before the specified string, the Logoff String will not be matched. 
Therefore the LoadMaster will not log the user off.


You can specify up to 255 characters for this parameter.		
										false
										false
										
									

									

										-ESPLogs
                                        
										Enable ESP logging. Valid values are below:
0 - Logging off
1 - User Access
2 - Security
3 - User Access and Security
4 - Connection
5 - User Access and Connection
6 - Security and connection
7 - User Access, Security and Connection


Note: The only valid values for SMTP services are 0 and 4. For SMTP services, security issues are always logged. Nothing is 
logged for user access because 
there are no logins.		
										false
										false
										
									

									

										-SMTPAllowedDomains
                                        
										Specifies all the permitted domains that are allowed to be received by this Virtual Service.
										false
										false
										
									

									

										-ESPEnabled
                                        
										Specifies whether to enable or disable the Edge Security Pack (ESP) features.
										false
										false
										
									

									

										-UserPwdChangeUrl
                                        
										This is relevant when using form-based or LDAP authentication. Specify the URL that users can use to change their password. 
If a user’s password has expired, or if they must reset their password, this URL and the UserPwdChangeMsg is displayed on 
the login form.
This URL must be put into the exception list for authentication, if required.		
										false
										false
										
									

									

										-UserPwdChangeMsg
                                        
										This parameter is only relevant if the UserPwdChangeURL parameter is set. Specify the text to be displayed on the login 
form when the user must reset their password.		
										false
										false
										
									

									

										-SecurityHeaderOptions
                                        
										Enable this option to add the Strict-Transport-Security header to all LoadMaster-generated messages (ESP and error 
messages).
0 - Don't add the Strict Transport Security Header (default value)
1 - Add the Strict Transport Security Header - no subdomains
2 - Add the Strict Transport Security Header - include subdomains		
										false
										false
										
									

									

										-InputAuthMode
                                        
										Specifies the client authentication method to be used:
0 - Delegate to Server
1 - Basic Authentication
2 - Form Based
3 - KCD
4 - Client Certificate
5 - NTLM		
										false
										false
										
									

									

										-OutConf
                                        
										Enter the name of the outbound SSO domain.
										false
										false
										
									

									

										-OutputAuthMode
                                        
										Specifies the server authentication mode to be used:
0 - None
1 - Basic Authentication
2 - Form Based
2 - KCD
4 - Server Token		
										false
										false
										
									

									

										-StartTLSMode
                                        
										0 - HTTP/HTTPS (the Service Type needs to be set to HTTP/HTTPS for this to work)


The Virtual Service Type must be set to STARTTLS for the remaining values to be set:
1 - SMTP (STARTTLS if requested)
2 - SMTP (STARTTLS always)
3 - FTP
4 - IMAP
6 - POP3		
										false
										false
										
									

									

										-MultiConnect
                                        
										Enabling this option permits the LoadMaster to manage connection handling between the LoadMaster and the Real Servers. 
Requests from multiple clients will be 
sent over the same TCP connection.
Multiplexing only works for simple HTTP GET operations. This parameter cannot be enabled in certain situations, for example 
if WAF, ESP or SSL Acceleration is 
enabled.		
										false
										false
										
									

									

										-SingleSignOnDir
                                        
										This parameter relates to the SSO Image Set drop-down in the ESP Options section of the modify Virtual Service screen. 
Specify the name of the image set to be used for the login screen. If no image set is specified, the default Exchange image 
set will be used.		
										false
										false
										
									

									

										-OCSPVerify
                                        
										Specifies whether to verify (via Online Certificate Status Protocol (OCSP)) that the client certificate is valid.
										false
										false
										
									

									

										-FollowVSID
                                        
										Specifies the ID of the Virtual Service to follow.
										false
										false
										
									

									

										-TlsType
                                        
										Specify which of the following protocols to support; SSLv3, TLS1.0, TLS1.1, TLS1.2, or TLS1.3. By default, TLS1.1, TLS1.2, 
and TLS1.3 are enabled. The protocols can be enabled and disabled using a bitmask value. Refer to the table below to find 
out what number corresponds to which settings.


Number |   SSLv3      | TLS1.0     | TLS1.1      | TLS1.2         | TLS1.3
0            |   Enabled   | Enabled  | Enabled   | Enabled       |  Enabled
1            |   Disabled  | Enabled  | Enabled   | Enabled       | Enabled
2            |   Enabled   | Disabled | Enabled   | Enabled       | Enabled
3            |   Disabled  | Disabled | Enabled   | Enabled       | Enabled
4            |   Enabled   | Enabled  | Disabled  | Enabled       | Enabled
5            |   Disabled  | Enabled  | Disabled  | Enabled       | Enabled
6            |   Enabled   | Disabled | Disabled  | Enabled       | Enabled
7            |   Disabled  | Disabled | Disabled  | Enabled       | Enabled
8            |   Enabled   | Enabled  | Enabled   | Disabled      | Enabled
9            |   Disabled  | Enabled  | Enabled   | Disabled      | Enabled
10          |   Enabled   | Disabled | Enabled   | Disabled      | Enabled
11          |   Disabled  | Disabled | Enabled   | Disabled      | Enabled
12          |   Enabled   | Enabled  | Disabled  | Disabled      | Enabled
13          |   Disabled  | Enabled  | Disabled  | Disabled      | Enabled
14          |   Enabled   | Disabled | Disabled  | Disabled      | Enabled
15          |   Disabled  | Disabled | Disabled  | Disabled      | Enabled
16          |   Enabled   | Enabled  | Enabled   | Enabled       | Disabled
17          |   Disabled |  Enabled  | Enabled   | Enabled       | Disabled
18          |   Enabled  |  Disabled | Enabled   | Enabled       | Disabled
19          |   Disabled |  Disabled | Enabled   | Enabled       | Disabled
20          |   Enabled  |  Enabled  | Disabled  | Enabled       | Disabled
21          |   Disabled |  Enabled  | Disabled  | Enabled       | Disabled
22          |   Enabled  |  Disabled | Disabled  | Enabled       | Disabled
23          |   Disabled |  Disabled | Disabled  | Enabled       | Disabled
24          |   Enabled  |   Enabled | Enabled   | Disabled      | Disabled
25          |   Disabled |   Enabled | Enabled   | Disabled      | Disabled
26          |   Enabled  |   Disabled | Enabled  | Disabled      | Disabled
27          |   Disabled |   Disabled | Enabled  | Disabled      | Disabled
28          |   Enabled  |   Enabled  | Disabled | Disabled      | Disabled
29          |   Disabled |   Enabled  | Disabled | Disabled      | Disabled
30          |   Enabled  |   Disabled | Disabled | Disabled      | Disabled		
										false
										false
										
									

									

										-CheckPostData
                                        
										This parameter is only relevant if the HTTP Method is set to POST. When using the POST method, up to 2047 characters of 
POST data can be sent to the server.		
										false
										false
										
									

									

										-CheckCodes
                                        
										A space-separated list of HTTP status codes that should be treated as successful when received from the Real Server.
Range: 300-599		
										false
										false
										
									

									

										-PreProcPrecedence
                                        
										This parameter should be used in conjunction with PreProcPrecedencePos. This parameter is used to specify the name of the 
existing rule whose position you wish to change. This parameter relates to Content Matching Rules only.		
										false
										false
										
									

									

										-PreProcPrecedencePos
                                        
										This parameter, in conjunction with the PreProcPrecedence parameter, is used to change the position of the rule in a 
sequence of rules. For example a position of 2 means the rule will be checked second. This parameter relates to the Content 
Matching Rules only.		
										false
										false
										
									

									

										-RequestPrecedence
                                        
										This parameter should be used in conjunction with RequestPrecedencePos. This parameter is used to specify the name of the 
existing request rule whose position you wish to change.


This parameter relates to the following rule types:
Content Matching
Add Header
Delete Header
Replace Header
Modify URL		
										false
										false
										
									

									

										-RequestPrecedencePos
                                        
										This parameter, in conjunction with the RequestPrecedence parameter, is used to change the position of the rule in a 
sequence of rules. For example a position of 2 means the rule will be checked second.		
										false
										false
										
									

									

										-ResponsePrecedence
                                        
										This parameter should be used in conjunction with ResponsePrecedencePos. This parameter is used to specify the name of the 
existing response rule whose position you wish to change.


This parameter relates to the following rule types:
Content Matching
Add Header
Delete Header
Replace Header		
										false
										false
										
									

									

										-ResponsePrecedencePos
                                        
										This parameter, in conjunction with the ResponsePrecedence parameter, is used to change the position of the rule in a 
sequence of rules. For example, a position of 2 means the rule will be checked second.		
										false
										false
										
									

									

										-RsRulePrecedence
                                        
										This parameter should be used in conjunction with RSRulePrecedencePos. This parameter is used to specify the name of the 
existing rule whose position you wish to change.		
										false
										false
										
									

									

										-RsRulePrecedencePos
                                        
										This parameter, in conjunction with the RSRulePrecedence parameter, is used to change the position of the rule in a 
sequence of rules. For example, a position of 2 means the rule will be checked second.		
										false
										false
										
									

									

										-NeedHostName
                                        
										When this parameter is enabled, the hostname is always required to be sent in the TLS client hello message. If it is not 
sent, the connection is dropped.
Valid values:
0 - Disabled
1 - Enabled		
										false
										false
										
									

									

										-CopyHdrFrom
                                        
										This is the name of the source header field to copy into the new header field before the request is sent to the Real 
Servers.		
										false
										false
										
									

									

										-CopyHdrTo
                                        
										This parameter is used in conjunction with the CopyHdrFrom parameter.
The name of the header field into which the source header is to be copied.		
										false
										false
										
									

									

										-ServerFbaPath
                                        
										Only relevant when using form-based authentication as the Server Authentication Mode (OutputAuthMode). Set the 
authentication path for server-side Form Based Authentication (FBA). When used in Exchange environments, this does not need 
to be set.		
										false
										false
										
									

									

										-ServerFbaPost
                                        
										Only relevant when using form-based authentication as the Server Athentication Mode (OutputAuthMode). Set the format string 
used to generate POST body for server side FBA. The value must be base64-encoded.
When used in Exchange environments, this does not need to be set.		
										false
										false
										
									

									

										-AddAuthHeader
                                        
										Specify the name of the HTTP header. This header is added to the HTTP request from the LoadMaster to the Real Server and 
its value is set to the user ID for the authenticated session. This option is only available if SAML is selected as the 
InputAuthMode. You can specify up to 255 characters for this parameter.		
										false
										false
										
									

									

										-Intercept
                                        
										Enable or disable the Web Application Firewall (WAF) for this Virtual Service.
										false
										false
										
									

									

										-InterceptOpts
                                        
										Specifies Web Application Firewall (WAF) options for this Virtual Service.
The AFP InterceptOpts parameter is a special parameter – it can be used to set the value for multiple fields, rather than 
just one field as with most other parameters. The InterceptOpts parameter allows the specification of most of the fields in 
the WAF Options section of the Virtual Service modify screen in the LoadMaster WUI.
To enable WAF, set the Intercept parameter to 1.
The names of the specific WUI fields that the InterceptOpts parameter is related to, are listed in the table below.


One or more field values can be set in one command. Multiple values can be set in the one command by separating the values 
with a semi-colon.
The values that are related to the same WUI option are mutually exclusive. For example, you cannot set Basic Operation to 
both opnormal and opblock.


Value               Related WUI Option                    Default         Meaning
opnormal            Default Operation                     Audit Only      Set the Basic Operation to Audit Only
opblock             Default Operation                     Audit Only      Set the Basic Operation to Block Mode
auditnone           Audit mode                            No Audit        Set the Audit mode to No Audit. No data is logged.
auditrelevant       Audit mode                            No Audit        Set the Audit mode to Audit Relevant. Logs data 
which is of a warning level and higher.
auditall            Audit mode                            No Audit        Set the Audit mode to Audit All. Logs all data 
through the Virtual Service.
The Audit All option is not recommended for use in normal operation.                          Audit All should only be used 
when troubleshooting a specific problem.
reqdataenable       Inspect HTML POST Request Content     Disabled        Enable the Inspect HTML POST Request Content 
option
reqdatadisable      Inspect HTML POST Request Content     Disabled        Disable the Inspect HTML POST Request Content 
option
resdataenable       Process Response Data                 Disabled        Enable the Process Response Data option
resdatadisable      Process Response Data                 Disabled        Disable the Process Response Data option
jsondisable         Enable JSON Parser                    Enabled        Disable the JSON parser. This option is only 
relevant if the Inspect HTML POST Request Content option is enabled.
jsonenable          Enable JSON Parser                    Enabled        Enable the JSON parser. This option is only 
relevant if the Inspect HTML POST Request Content option is enabled.
xmldisable          Enable XML Parser                     Enabled        Disable the XML parser. This option is only 
relevant if the Inspect HTML POST Request Content option is enabled.
xmlenable           Enable XML Parser                     Enabled        Enable the XML parser. This option is only 
relevant if the Inspect HTML POST Request Content option is enabled.
otherctypesdisable  Enable Other Content Types            Disabled       Disable verification of POST content types (other 
than XML/JSON).
otherctypesenable   Enable Other Content Types            Disabled       Enable verification of POST content types (other 
than XML/JSON).
Enabling the inspection of any other content types may increase system resource utilization (CPU and memory). A specific 
list of content types should be considered.
When this option is enabled, the InterceptPOSTOtherContentTypes parameter can be used to enter a comma-separated list of 
POST content types allowed for WAF analysis. By default, all types (other than XML/JSON) are enabled.		
										false
										false
										
									

									

										-InterceptRules
                                        
										Specifies Web Application Firewall (WAF) rules for this Virtual Service.
										false
										false
										
									

									

										-InterceptPostOtherContentTypes
                                        
										When the otherctypesenable option (in the InterceptOpts parameter) is enabled, use the InterceptPOSTOtherContentTypes 
parameter to enter a comma-separated list of POST content types allowed for WAF analysis, for example text/plain,text/css. 
By default, all types (other than XML/JSON) are enabled. To set this to any other content types, set the value to any.


Warning: Enabling the inspection of any other content types may increase system resource utilization (CPU and memory). A 
specific list of content types should be considered.		
										false
										false
										
									

									

										-AlertThreshold
                                        
										Specifies Web Application Firewall (WAF) alert threshold for this Virtual Service
										false
										false
										
									

									

										-Weight
                                        
										Specify the weight of this SubVS.
										false
										false
										
									

									

										-Limit
                                        
										The maximum number of connections that can be sent to this SubVS before it is taken out of rotation from the main Virtual 
Service (the maximum limit is 100000).		
										false
										false
										
									

									

										-Critical
                                        
										Indicate that this SubVS is required for the Virtual Service to be available.
										false
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-AllowHTTP2
                                        
										Enable HTTP2 for this Virtual Service. SSL Acceleration must be enabled before HTTP2 can be enabled. The Best Practices 
cipher set should be used when HTTP2 is enabled.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Set-AdcSubVirtualService -SubVSIndex 3 -CheckType http

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.
Data field...: @{VS=}
Param........: @{Status=Down; Index=3; VSPort=0; Layer=7; Enable=Y; SSLReverse=N; SSLReencrypt=N; Intercept=N; 
InterceptOpts=; AlertThreshold=0; Transac
tionlimit=0; Transparent=N; SubnetOriginating=Y; ServerInit=0; StartTLSMode=0; Idletime=660; Cache=N; Compress=N; Verify=0; 
UseforSnat=N; ForceL4=N; For
ceL7=Y; MultiConnect=N; ClientCert=0; ErrorCode=0; CheckUse1.1=N; MatchLen=0; CheckUseGet=0; SSLRewrite=0; VStype=http; 
FollowVSID=0; Protocol=tcp; Sche
dule=rr; CheckType=http; PersistTimeout=0; CheckPort=0; NRules=0; NRequestRules=0; NResponseRules=0; NPreProcessRules=0; 
EspEnabled=N; InputAuthMode=0; 
OutputAuthMode=0; MasterVS=0; MasterVSID=1; IsTransparent=2; AddVia=0; QoS=0; TlsType=0; NeedHostName=N; OCSPVerify=N; 
AllowHTTP2=N; EnhancedHealthCheck
s=N; RsMinimum=0; NumberOfRSs=0}

                            

						

                        
Top of page
				

				

					

						
 Set-AdcVirtualService 

						
Set options on a configured Virtual Service.

						
Modifies the settings for a configured Virtual Service.

					

                        

                        
 Syntax 

                        

						

                            


Set-AdcVirtualService [-VirtualService <String>] [-VSPort <Int32>] [-VSProtocol <String>] [-VSIndex <Int32>] [-AddVia 
<Int16>] [-Cache <Boolean>] [-CertFile <String>] [-CheckType <String>] [-CheckHost <String>] [-CheckPattern <String>] 
[-CheckUrl <String>] [-CheckHeaders <String>] [-LdapEndpoint <String>] [-MatchLen <String>] [-CheckUse1_1 <Int32>] 
[-CheckPort <Int32>] [-EnhancedHealthChecks <Boolean>] [-RsMinimum <Int32>] [-ClientCert <Int16>] [-Compress <Boolean>] 
[-Cookie <String>] [-CachePercent <Int16>] [-DefaultGW <String>] [-Enable <Boolean>] [-ErrorCode <String>] [-ErrorUrl 
<String>] [-PortFollow <Int32>] [-ForceL7 <Boolean>] [-Idletime <Int32>] [-LocalBindAddresses <String[]>] [-VSType 
<String>] [-Nickname <String>] [-Persist <String>] [-PersistTimeout <Int32>] [-QueryTag <String>] [-CipherSet <String>] 
[-SSLReencrypt <Boolean>] [-SSLReverse <Boolean>] [-SSLRewrite <String>] [-ReverseSNIHostname <String>] [-Schedule 
<String>] [-ServerInit <Int16>] [-SSLAcceleration <Boolean>] [-StandByAddr <String>] [-StandByPort <String>] 
[-TransactionLimit <Int32>] [-Transparent <Boolean>] [-SubnetOriginating <Boolean>] [-UseforSnat <Boolean>] [-QoS <String>] 
[-CheckUseGet <Int32>] [-Verify <Int16>] [-ExtraHdrKey <String>] [-ExtraHdrValue <String>] [-AllowedHosts <String>] 
[-AllowedDirectories <String>] [-ExcludedDirectories <String>] [-AllowedGroups <String>] [-GroupSIDs <String>] 
[-SteeringGroups <String>] [-IncludeNestedGroups <Boolean>] [-DisplayPubPriv <Boolean>] [-DisablePasswordForm <Boolean>] 
[-Domain <String>] [-AltDomains <String>] [-Logoff <String>] [-ESPLogs <Int16>] [-SMTPAllowedDomains <String>] [-ESPEnabled 
<Boolean>] [-UserPwdChangeUrl <String>] [-UserPwdChangeMsg <String>] [-SecurityHeaderOptions <Int16>] [-InputAuthMode 
<Int16>] [-OutConf <String>] [-OutputAuthMode <Int16>] [-StartTLSMode <Int16>] [-ExtraPorts <String>] [-AltAddress 
<String>] [-MultiConnect <Boolean>] [-SingleSignOnDir <String>] [-OCSPVerify <String>] [-FollowVSID <Int32>] [-TlsType 
<Int32>] [-CheckPostData <String>] [-CheckCodes <String>] [-PreProcPrecedence <String>] [-PreProcPrecedencePos <Int16>] 
[-RequestPrecedence <String>] [-RequestPrecedencePos <Int16>] [-ResponsePrecedence <String>] [-ResponsePrecedencePos 
<Int16>] [-RsRulePrecedence <String>] [-RsRulePrecedencePos <Int16>] [-NeedHostName <Boolean>] [-CopyHdrFrom <String>] 
[-CopyHdrTo <String>] [-ServerFbaPath <String>] [-ServerFbaPost <String>] [-AddAuthHeader <String>] [-Intercept <Boolean>] 
[-AllowHTTP2 <Boolean>] [-InterceptOpts <String>] [-InterceptRules <String>] [-InterceptPostOtherContentTypes <String>] 
[-AlertThreshold <Int32>] [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Set-AdcVirtualService [-VirtualService <String>] [-VSPort <Int32>] [-VSProtocol <String>] [-VSIndex <Int32>] [-AddVia 
<Int16>] [-Cache <Boolean>] [-CertFile <String>] [-CheckType <String>] [-CheckHost <String>] [-CheckPattern <String>] 
[-CheckUrl <String>] [-CheckHeaders <String>] [-LdapEndpoint <String>] [-MatchLen <String>] [-CheckUse1_1 <Int32>] 
[-CheckPort <Int32>] [-EnhancedHealthChecks <Boolean>] [-RsMinimum <Int32>] [-ClientCert <Int16>] [-Compress <Boolean>] 
[-Cookie <String>] [-CachePercent <Int16>] [-DefaultGW <String>] [-Enable <Boolean>] [-ErrorCode <String>] [-ErrorUrl 
<String>] [-PortFollow <Int32>] [-ForceL7 <Boolean>] [-Idletime <Int32>] [-LocalBindAddresses <String[]>] [-VSType 
<String>] [-Nickname <String>] [-Persist <String>] [-PersistTimeout <Int32>] [-QueryTag <String>] [-CipherSet <String>] 
[-SSLReencrypt <Boolean>] [-SSLReverse <Boolean>] [-SSLRewrite <String>] [-ReverseSNIHostname <String>] [-Schedule 
<String>] [-ServerInit <Int16>] [-SSLAcceleration <Boolean>] [-StandByAddr <String>] [-StandByPort <String>] 
[-TransactionLimit <Int32>] [-Transparent <Boolean>] [-SubnetOriginating <Boolean>] [-UseforSnat <Boolean>] [-QoS <String>] 
[-CheckUseGet <Int32>] [-Verify <Int16>] [-ExtraHdrKey <String>] [-ExtraHdrValue <String>] [-AllowedHosts <String>] 
[-AllowedDirectories <String>] [-ExcludedDirectories <String>] [-AllowedGroups <String>] [-GroupSIDs <String>] 
[-SteeringGroups <String>] [-IncludeNestedGroups <Boolean>] [-DisplayPubPriv <Boolean>] [-DisablePasswordForm <Boolean>] 
[-Domain <String>] [-AltDomains <String>] [-Logoff <String>] [-ESPLogs <Int16>] [-SMTPAllowedDomains <String>] [-ESPEnabled 
<Boolean>] [-UserPwdChangeUrl <String>] [-UserPwdChangeMsg <String>] [-SecurityHeaderOptions <Int16>] [-InputAuthMode 
<Int16>] [-OutConf <String>] [-OutputAuthMode <Int16>] [-StartTLSMode <Int16>] [-ExtraPorts <String>] [-AltAddress 
<String>] [-MultiConnect <Boolean>] [-SingleSignOnDir <String>] [-OCSPVerify <String>] [-FollowVSID <Int32>] [-TlsType 
<Int32>] [-CheckPostData <String>] [-CheckCodes <String>] [-PreProcPrecedence <String>] [-PreProcPrecedencePos <Int16>] 
[-RequestPrecedence <String>] [-RequestPrecedencePos <Int16>] [-ResponsePrecedence <String>] [-ResponsePrecedencePos 
<Int16>] [-RsRulePrecedence <String>] [-RsRulePrecedencePos <Int16>] [-NeedHostName <Boolean>] [-CopyHdrFrom <String>] 
[-CopyHdrTo <String>] [-ServerFbaPath <String>] [-ServerFbaPost <String>] [-AddAuthHeader <String>] [-Intercept <Boolean>] 
[-AllowHTTP2 <Boolean>] [-InterceptOpts <String>] [-InterceptRules <String>] [-InterceptPostOtherContentTypes <String>] 
[-AlertThreshold <Int32>] [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN 
<String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-VirtualService
                                        
										The IP address for the Virtual Service.
										false
										false
										
									

									

										-VSPort
                                        
										The port for the Virtual Service.
The port parameter is used to assign a port when initially creating a Virtual Service. If modifying the port of an existing 
Virtual Service, specify the existing port as the Port parameter and use the VSPort parameter to assign the new port.
The reason why these must be separate parameters is because you need to specify what the port of the existing Virtual 
Service is (because there may be another Virtual Service with the same IP address but a different port) and if you want to 
change the port, a second port parameter (VSPort) is needed to specify the new port value.		
										false
										false
										
									

									

										-VSProtocol
                                        
										The protocol of the relevant Virtual Service.
										false
										false
										
									

									

										-VSIndex
                                        
										The index number of the Virtual Service.
										false
										false
										
									

									

										-AddVia
                                        
										Specifies which headers are added to the HTTP stream.  Choose the number of the option to use.


0 - Legacy Operation(XXX)
1 - None
2 - X-Forwarded-For
3 - X-Forwarded-For (No Via)
4 - X-ClientSide
5 - X-ClientSide (No Via)
6 - Via Only		
										false
										false
										
									

									

										-Cache
                                        
										Enables or disables caching on this Virtual Service.
										false
										false
										
									

									

										-CertFile
                                        
										Specifies the name of the certificate file to use that is already installed on the load balancer. Note: This will NOT 
upload a certificate file to the load balancer.		
										false
										false
										
									

									

										-CheckType
                                        
										Specifies the protocol to use to check if the service is up. Valid options are "tcp", "icmp", "https", "http", "smtp", 
"nntp", "ftp", "telnet", "pop3", "imap", "rdp", "ldap" or "none".		
										false
										false
										
									

									

										-CheckHost
                                        
										The address to use to check if the service is up.
										false
										false
										
									

									

										-CheckPattern
                                        
										A regular expression string that can be validate on a 200 reply to determine if the service is up.
Specify an empty value to unset CheckPattern.		
										false
										false
										
									

									

										-CheckUrl
                                        
										The URL to check if the service is up. The maximum character length for the CheckUrl parameter value is 126 characters.
										false
										false
										
									

									

										-CheckHeaders
                                        
										Specify up to four additional headers/fields which will be sent with each health check request. Separate the pairs with a 
pipe, for example; Host:xyc|UserAgent:prq.		
										false
										false
										
									

									

										-LdapEndpoint
                                        
										Specify the LDAP endpoint to use for health checks (if LDAP is selected as the CheckType). If LDAP is selected as the 
health check protocol, the server IP address (or addresses) and ports from the LDAP endpoint configuration will be used 
instead of the Real Server IP address and port.		
										false
										false
										
									

									

										-MatchLen
                                        
										This parameter is only relevant when the CheckType is set to "bdata". Specify the number of bytes to find the CheckPattern 
within.		
										false
										false
										
									

									

										-CheckUse1_1
                                        
										Specifies that the health checker use HTTP/1.1 instead of HTTP/1.0. By default, the health checker uses HTTP/1.0 when 
checking the Real Server status. Enabling CheckUse1_1 means HTTP/1.1 is used (which is more efficient).
Note: Optimization only works on HTTP (not HTTPS) connections.
0 - HTTP/1.0
1 - HTTP/1.1		
										false
										false
										
									

									

										-CheckPort
                                        
										The port to use to check if the service is up.
Specify 0 to unset CheckPort.		
										false
										false
										
									

									

										-EnhancedHealthChecks
                                        
										Enables or disables Enhanced Health Check Options for the Virtual Service.
										false
										false
										
									

									

										-RsMinimum
                                        
										Specifies the minimum number of Real Servers that are required to be active for the Virtual Service to be considered up.
										false
										false
										
									

									

										-ClientCert
                                        
										Specify how client certificates should be used. Valid values are 0, 1, or 2. Zero indicates that client certificates are 
not use. One indicates that client certificates are required. Two indicates that client certificates are required and 
additional HEAD information is being sent.		
										false
										false
										
									

									

										-Compress
                                        
										Enable or disable file compression for the Virtual Service.
										false
										false
										
									

									

										-Cookie
                                        
										Specifies a cookie name. This parameter is only relevant when the persistence mode is set to "cookie", "active-cookie", 
"cookie-src" or "active-cook-src".		
										false
										false
										
									

									

										-CachePercent
                                        
										Specifies the maximum cache usage for this virtual service.


Note: Setting two Virtual Services using 50% of cache will use 100% of all cache storage. This parameter accepts values 
from 0 to 100.		
										false
										false
										
									

									

										-DefaultGW
                                        
										Specifies a Virtual Service-specific default gateway to be used to send responses back to clients. If not set, the global 
default gateway will be used.		
										false
										false
										
									

									

										-Enable
                                        
										Enables or disables the Virtual Service.
										false
										false
										
									

									

										-ErrorCode
                                        
										If no Real Servers are available, the LoadMaster can terminate the connection with an HTTP error code. Specify the error 
code number in this parameter.		
										false
										false
										
									

									

										-ErrorUrl
                                        
										When no Real Servers are available and an error response is sent back to the client, a redirect URL can also be specified.
										false
										false
										
									

									

										-PortFollow
                                        
										This parameter was depreciated as of 7.1-24. For LoadMasters with version 7.1-24 or higher, use the FollowVSID parameter to 
set port following.		
										false
										false
										
									

									

										-ForceL7
                                        
										Enabling ForceL7 means the Virtual Service runs at Layer 7 and not Layer 4. This may be needed for various reasons, 
including that only Layer 7 services can be non-transparent.		
										false
										false
										
									

									

										-Idletime
                                        
										Specifies the length of time (in seconds) that a connection may remain idle before it is closed. The range for this 
parameter is 0 to 86400. 
Setting the Idletime to 0 ensures the default L7 connection timeout is used. You can modify the default timeout value by 
setting the conntimeout parameter.		
										false
										false
										
									

									

										-LocalBindAddresses
                                        
										Specifies a space-separated list of IP addresses. This corresponds to the Alternate Source Address in the Advanced 
Properties section of the WUI. Allow connections scaling over 64K Connections needs to be enabled in L7 Configuration for 
this feature to work.		
										false
										false
										
									

									

										-VSType
                                        
										Specifies the type of service being load balanced:


gen - Generic
http - HTTP/HTTPS
ts - Remote Terminal
tls – STARTTLS protocols
log – Log Insight		
										false
										false
										
									

									

										-Nickname
                                        
										Specifies the "friendly" name of the service. In addition to the usual alphanumeric characters, the following "special" 
characters can be used as part of the Service Name:


. @ - _


However, there must be at least one alphanumeric character before the special characters.		
										false
										false
										
									

									

										-Persist
                                        
										Specifies the type of persistence (stickiness) to be used for this Virtual Service.


The following persistence values are supported: ssl, cookie, active-cookie, cookie-src, active-cook-src, cookie-hash, 
cookie-hash-src, url, query-hash, host, header, super, super-src, src, rdp, rdp-src, rdp-sb, rdp-sb-src, udpsip and none.


Note: If setting the persistence mode to an option that requires a cookie (or query-hash), the cookie parameter must also 
be set.		
										false
										false
										
									

									

										-PersistTimeout
                                        
										The length of time (in seconds) after the last connection that the LoadMaster will remember the persistence information. 
Timeout values are rounded down to an even number of minutes. Setting a value that is not a number of whole minutes results 
in the excess being ignored. Setting a value to less than 60 seconds results in a value of 0 being set, which disables 
persistency.		
										false
										false
										
									

									

										-QueryTag
                                        
										This is the query tag to be matched if the Persist type is set to query-hash.
										false
										false
										
									

									

										-CipherSet
                                        
										This parameter can be used to assign a cipher set to a Virtual Service. System-defined cipher sets and custom cipher sets 
can be assigned using this parameter. The valid values are below:
 - Default
 - Default_NoRc4
 - BestPractices
 - Intermediate_compatibility
 - Backward_compatibility
 - WUI
 - FIPS
 - Legacy
 - Null_Ciphers
 - <NameOfCustomCipherSet>		
										false
										false
										
									

									

										-SSLReencrypt
                                        
										This parameter is only relevant if SSL Acceleration is enabled. When this option is enabled, the SSL data stream is 
re-encrypted before sending to the Real Server.		
										false
										false
										
									

									

										-SSLReverse
                                        
										Enabling this parameter means that the data from the LoadMaster to the Real Server is re-encrypted.
										false
										false
										
									

									

										-SSLRewrite
                                        
										When the Real Server rejects a request with an HTTP redirect, the requesting Location URL may need to be converted to 
specify HTTPS instead of HTTP (and vice versa).		
										false
										false
										
									

									

										-ReverseSNIHostname
                                        
										If this option is enabled, the host name is required to be sent in the TLS client hello message. If it is not sent the 
connection will be dropped.		
										false
										false
										
									

									

										-Schedule
                                        
										Specifies the type of scheduling of new connections to Real Servers that is to be performed. The following values are 
supported:


rr = round robin
wrr = weighted round robin
lc = least connection
wlc = weighted least connection
fixed = fixed weighting
adaptive = resource based (adaptive)
sh = source IP hash
dl = weighted response time
sdn-adaptive = resource based (SDN adaptive)		
										false
										false
										
									

									

										-ServerInit
                                        
										Specifies one of the following values:


0 - Normal Protocols
1 - SMTP
2 - SSH
3 - Other Server Initiating
4 - IMAP4
5 - MySQL
6 - POP3		
										false
										false
										
									

									

										-SSLAcceleration
                                        
										Specifies whether to enable SSL handling on the Virtual Service.
										false
										false
										
									

									

										-StandByAddr
                                        
										Specifies the IP address of the "Sorry" server that is to be used when no other Real Servers are available. This server 
will not be health checked and is assumed to be always available.		
										false
										false
										
									

									

										-StandByPort
                                        
										Specifies the port of the "Sorry" server.
										false
										false
										
									

									

										-TransactionLimit
                                        
										This is a legacy parameter that should no longer be used. It was used previously when the SSL proxy was limited to 6K total 
connections. The transaction limit was used to limit one Virtual Service to only handle so many connections out of this 6K. 
On newer systems, where the limit is greater than 64K - this feature is no longer required.		
										false
										false
										
									

									

										-Transparent
                                        
										When using Layer 7, when this is enabled - the connection arriving at the Real Server appears to come directly from the 
client. Alternatively, the connection can be non-transparent, which means that the connections at the Real Server appear to 
come from the LoadMaster.
0 - Disabled
1 - Enabled
If a Virtual Service (with or without a SubVS) has SSL re-encrypt enabled, the transparency flag of the Virtual Service has 
no meaning (re-encryption forces transparency to be off). The transparency setting can still be modified by the API, and is 
honored when re-encrypt is disabled on the Virtual Service.		
										false
										false
										
									

									

										-SubnetOriginating
                                        
										When transparency is not enabled, the source IP address of connections to the Real Servers is that of the Virtual Service. 
When transparency is enabled, the source IP address will be the IP address that is initiating connection to the Virtual 
Service. If the Real Server is on a subnet, and the Subnet Originating Requests option is enabled, then the subnet address 
of the LoadMaster will be used as the source IP address.		
										false
										false
										
									

									

										-UseforSnat
                                        
										By default, when the LoadMaster is being used to NAT Real Servers, the source IP address used on the Internet is that of 
the LoadMaster. Enabling this option allows the Real Servers configured to use the Virtual Service as the source IP address 
instead. If the Real Servers are configured on more than one Virtual Service which has this option set, only connections to 
destination port 80 will use this Virtual Service as the source IP address.		
										false
										false
										
									

									

										-QoS
                                        
										Specifies the Quality of Service. The following values are supported:


0 - Normal-Service
1 - Minimize-Cost
2 - Maximize-Reliability
4 - Maximize-Throughput
8 - Minimize-Delay		
										false
										false
										
									

									

										-CheckUseGet
                                        
										When accessing the health check URL - the system can use the HEAD, the GET or the POST method:


0 - HEAD
1 - GET
2 - POST		
										false
										false
										
									

									

										-Verify
                                        
										Specifies a verification bitmask. The valid values of the Verify parameter are as follows:


Bit 0: set this to 1 to enable detection intrusion.


Note: Bit 0 needs to be set to 1 in order to use the other two bits.


Bit 1: Determines whether to reject or drop a connection. Setting it to 1 will drop the connection.


Bit 2: Determines whether to give just warnings on bad requests or also on malicious (but not invalid) requests.


The following table lists the valid integers and the values they set the fields to when used:  
Integer       Detect Malicious Requests           Intrusion Handling          Warnings Checkbox
0             Disabled                            N/A                         N/A
1             Enabled                             Drop Connection             Unchecked
2             Enabled                             Send Reject                 Unchecked
3             Enabled                             Send Reject                 Unchecked
4             Enabled                             Drop Connection             Checked
5             Enabled                             Drop Connection             Checked
6             Enabled                             Send Reject                 Checked
7             Enabled                             Send Reject                 Checked		
										false
										false
										
									

									

										-ExtraHdrKey
                                        
										Specifies the key for the extra header to be inserted into every request sent to the Real Servers.
										false
										false
										
									

									

										-ExtraHdrValue
                                        
										Specifies the value for the extra header to be inserted into every request sent to the Real Servers.
										false
										false
										
									

									

										-AllowedHosts
                                        
										This parameter is only relevant when ESP is enabled. Specifies all the virtual hosts that can be accessed via this Virtual 
Service.		
										false
										false
										
									

									

										-AllowedDirectories
                                        
										This parameter is only relevant when ESP is enabled. Specify all the virtual directories that can be accessed using this 
Virtual Service. You can specify up to 254 characters for this parameter.		
										false
										false
										
									

									

										-ExcludedDirectories
                                        
										This parameter is only relevant when ESP is enabled. Any virtual directories specified within this field will not be 
pre-authorized on this Virtual Service and are passed directly to the relevant Real Servers.		
										false
										false
										
									

									

										-AllowedGroups
                                        
										Specifies the groups that are allowed to access this Virtual Service. You can specify up to 2048 characters for this 
parameter. If the parameter value is longer than the maximum length of a HTTP GET query (1024 characters), you must set the 
HTTP Method to POST.		
										false
										false
										
									

									

										-GroupSIDs
                                        
										Specify the group security identifiers (SIDs) that are allowed to access this Virtual Service. This parameter allows a list 
of group SIDs of up to 64 bytes and 2048 characters in length. Each group is separated by a semi-colon. Spaces are used to 
separate bytes in certain group SIDs. Here is an example:
S-1-5-21-703902271-2531649136-2593404273-1606
SIDs can be found by using the get-adgroup-Identity GroupName command.
If the parameter value is longer than the maximum length of HTTP GET query (1024 characters), you must set the HTTP Method 
to POST.		
										false
										false
										
									

									

										-SteeringGroups
                                        
										Enter the Active Directory group names that will be used for steering traffic. Use a semi-colon to separate multiple group 
names. The steering group index number corresponds to the location of the group in this list. You can specify up to 2048 
characters for this parameter. If the parameter value is longer than the maximum length of a HTTP GET query (1024 
characters), you must set the HTTP Method to POST.		
										false
										false
										
									

									

										-IncludeNestedGroups
                                        
										Specify if nested groups should be included in the authentication attempt.
										false
										false
										
									

									

										-DisplayPubPriv
                                        
										Display the public/private option on the login page. Based on the option the user selects on the login form, the session 
timeout value will be set to the value specified for either the public or private timeout.		
										false
										false
										
									

									

										-DisablePasswordForm
                                        
										Enabling this option removes the password field from the login page. This may be needed when password validation is not 
required, for example if using RSA SecurID authentication in a singular fashion.		
										false
										false
										
									

									

										-Domain
                                        
										Specifies the Single Sign On (SSO) domain in which this Virtual Service will operate.
										false
										false
										
									

									

										-AltDomains
                                        
										Specifies alternative domains to be assigned to a Virtual Service when configuring multi-domain authentication. To specify 
multiple alternative domains use a space-separated list.		
										false
										false
										
									

									

										-Logoff
                                        
										This parameter is only relevant when ESP is enabled and when the Client Authentication Mode is set to Form Based. Specify 
the string that the LoadMaster should use to detect a logout event. Multiple logoff strings can be specified by using a 
space-separated list.


If the URL to be matched contains sub-directories before the specified string, the Logoff String will not be matched. 
Therefore the LoadMaster will not log the user off.


You can specify up to 255 characters for this parameter.		
										false
										false
										
									

									

										-ESPLogs
                                        
										Enable ESP logging. Valid values are below:


0 - Logging off
1 - User Access
2 - Security
3 - User Access and Security
4 - Connection
5 - User Access and Connection
6 - Security and connection
7 - User Access, Security and Connection


Note: The only valid values for SMTP services are 0 and 4. For SMTP services, security issues are always logged. Nothing is 
logged for user access because there are no logins.		
										false
										false
										
									

									

										-SMTPAllowedDomains
                                        
										Specifies all the permitted domains that are allowed to be received by this Virtual Service.
										false
										false
										
									

									

										-ESPEnabled
                                        
										Specifies whether to enable or disable the Edge Security Pack (ESP) features.
										false
										false
										
									

									

										-UserPwdChangeUrl
                                        
										This is relevant when using form-based LDAP authentication. Specify the URL that users can use to change their password. If 
a user’s password has expired, or if they must reset their password, this URL and the UserPwdChangeMsg is displayed on the 
login form.
This URL must be put into the exception list for authentication, if required.		
										false
										false
										
									

									

										-UserPwdChangeMsg
                                        
										This parameter is only relevant if the UserPwdChangeURL parameter is set. Specify the text to be displayed on the login 
form when the user must reset their password.		
										false
										false
										
									

									

										-SecurityHeaderOptions
                                        
										Enable this option to add the Strict-Transport-Security header to all LoadMaster-generated messages (ESP and error 
messages).
0 - Don't add the Strict Transport Security Header (default value)
1 - Add the Strict Transport Security Header - no subdomains
2 - Add the Strict Transport Security Header - include subdomains Enable this option to add the Strict-Transport-Security 
header to all LoadMaster-generated messages (ESP and error messages).		
										false
										false
										
									

									

										-InputAuthMode
                                        
										Specifies the client authentication method to be used:


0 - Delegate to Server
1 - Basic Authentication
2 - Form Based
4 - Client Certificate
5 - NTLM
6 - SAML		
										false
										false
										
									

									

										-OutConf
                                        
										Enter the name of the outbound SSO domain.
										false
										false
										
									

									

										-OutputAuthMode
                                        
										Specifies the server authentication mode to be used:


0 - None
1 - Basic Authentication
2 - Form Based
3 - KCD
4 - Server Token		
										false
										false
										
									

									

										-StartTLSMode
                                        
										0 - HTTP/HTTPS (the Service Type needs to be set to HTTP/HTTPS for this to work)


The Virtual Service Type must be set to STARTTLS for the remaining values to be set:


1 - SMTP (STARTTLS if requested)
2 - SMTP (STARTTLS always)
3 - FTP
4 - IMAP
6 - POP3		
										false
										false
										
									

									

										-ExtraPorts
                                        
										Specifies extra ports that the Virtual Service will listen to.
										false
										false
										
									

									

										-AltAddress
                                        
										Specifies the alternate address for this Virtual Service.
										false
										false
										
									

									

										-MultiConnect
                                        
										Enabling this option permits the LoadMaster to manage connection handling between the LoadMaster and the Real Servers. 
Requests from multiple clients will be sent over the same TCP connection.


Multiplexing only works for simple HTTP GET operations. This parameter cannot be enabled in certain situations, for example 
if WAF, ESP or SSL Acceleration is enabled.		
										false
										false
										
									

									

										-SingleSignOnDir
                                        
										This parameter relates to the SSO Image Set drop-down in the ESP Options section of the modify Virtual Service screen. 
Specify the name of the image set to be used for the login screen. If no image set is specified, the default Exchange image 
set will be used.		
										false
										false
										
									

									

										-OCSPVerify
                                        
										Specifies whether to verify (via Online Certificate Status Protocol (OCSP)) that the client certificate is valid.
										false
										false
										
									

									

										-FollowVSID
                                        
										Specifies the ID of the Virtual Service to follow.
										false
										false
										
									

									

										-TlsType
                                        
										Specify which of the following protocols to support; SSLv3, TLS1.0, TLS1.1, TLS1.2, or TLS1.3. By default, TLS1.1, TLS1.2, 
and TLS1.3 are enabled. The protocols can be enabled and disabled using a bitmask value. Refer to the table below to find 
out what number corresponds to which settings.


Number |   SSLv3      | TLS1.0     | TLS1.1      | TLS1.2         | TLS1.3
0            |   Enabled   | Enabled  | Enabled   | Enabled       |  Enabled
1            |   Disabled  | Enabled  | Enabled   | Enabled       | Enabled
2            |   Enabled   | Disabled | Enabled   | Enabled       | Enabled
3            |   Disabled  | Disabled | Enabled   | Enabled       | Enabled
4            |   Enabled   | Enabled  | Disabled  | Enabled       | Enabled
5            |   Disabled  | Enabled  | Disabled  | Enabled       | Enabled
6            |   Enabled   | Disabled | Disabled  | Enabled       | Enabled
7            |   Disabled  | Disabled | Disabled  | Enabled       | Enabled
8            |   Enabled   | Enabled  | Enabled   | Disabled      | Enabled
9            |   Disabled  | Enabled  | Enabled   | Disabled      | Enabled
10          |   Enabled   | Disabled | Enabled   | Disabled      | Enabled
11          |   Disabled  | Disabled | Enabled   | Disabled      | Enabled
12          |   Enabled   | Enabled  | Disabled  | Disabled      | Enabled
13          |   Disabled  | Enabled  | Disabled  | Disabled      | Enabled
14          |   Enabled   | Disabled | Disabled  | Disabled      | Enabled
15          |   Disabled  | Disabled | Disabled  | Disabled      | Enabled
16          |   Enabled   | Enabled  | Enabled   | Enabled       | Disabled
17          |   Disabled |  Enabled  | Enabled   | Enabled       | Disabled
18          |   Enabled  |  Disabled | Enabled   | Enabled       | Disabled
19          |   Disabled |  Disabled | Enabled   | Enabled       | Disabled
20          |   Enabled  |  Enabled  | Disabled  | Enabled       | Disabled
21          |   Disabled |  Enabled  | Disabled  | Enabled       | Disabled
22          |   Enabled  |  Disabled | Disabled  | Enabled       | Disabled
23          |   Disabled |  Disabled | Disabled  | Enabled       | Disabled
24          |   Enabled  |   Enabled | Enabled   | Disabled      | Disabled
25          |   Disabled |   Enabled | Enabled   | Disabled      | Disabled
26          |   Enabled  |   Disabled | Enabled  | Disabled      | Disabled
27          |   Disabled |   Disabled | Enabled  | Disabled      | Disabled
28          |   Enabled  |   Enabled  | Disabled | Disabled      | Disabled
29          |   Disabled |   Enabled  | Disabled | Disabled      | Disabled
30          |   Enabled  |   Disabled | Disabled | Disabled      | Disabled		
										false
										false
										
									

									

										-CheckPostData
                                        
										This parameter is only relevant if the HTTP Method is set to POST. When using the POST method, up to 2047 characters of 
POST data can be sent to the server.		
										false
										false
										
									

									

										-CheckCodes
                                        
										A space-separated list of HTTP status codes that should be treated as successful when received from the Real Server.
Range: 300-599		
										false
										false
										
									

									

										-PreProcPrecedence
                                        
										This parameter should be used in conjunction with PreProcPrecedencePos. This parameter is used to specify the name of the 
existing rule whose position you wish to change. This parameter relates to Content Matching Rules only.		
										false
										false
										
									

									

										-PreProcPrecedencePos
                                        
										This parameter, in conjunction with the PreProcPrecedence parameter, is used to change the position of the rule in a 
sequence of rules. For example a position of 2 means the rule will be checked second. This parameter relates to the Content 
Matching Rules only.		
										false
										false
										
									

									

										-RequestPrecedence
                                        
										This parameter should be used in conjunction with RequestPrecedencePos. This parameter is used to specify the name of the 
existing request rule whose position you wish to change.


This parameter relates to the following rule types:


Content Matching
Add Header
Delete Header
Replace Header
Modify URL		
										false
										false
										
									

									

										-RequestPrecedencePos
                                        
										This parameter, in conjunction with the RequestPrecedence parameter, is used to change the position of the rule in a 
sequence of rules. For example a position of 2 means the rule will be checked second.		
										false
										false
										
									

									

										-ResponsePrecedence
                                        
										This parameter should be used in conjunction with ResponsePrecedencePos. This parameter is used to specify the name of the 
existing response rule whose position you wish to change.


This parameter relates to the following rule types:


Content Matching
Add Header
Delete Header
Replace Header		
										false
										false
										
									

									

										-ResponsePrecedencePos
                                        
										This parameter, in conjunction with the ResponsePrecedence parameter, is used to change the position of the rule in a 
sequence of rules. For example, a position of 2 means the rule will be checked second.		
										false
										false
										
									

									

										-RsRulePrecedence
                                        
										This parameter should be used in conjunction with RSRulePrecedencePos. This parameter is used to specify the name of the 
existing rule whose position you wish to change.		
										false
										false
										
									

									

										-RsRulePrecedencePos
                                        
										This parameter, in conjunction with the RSRulePrecedence parameter, is used to change the position of the rule in a 
sequence of rules. For example, a position of 2 means the rule will be checked second.		
										false
										false
										
									

									

										-NeedHostName
                                        
										When this parameter is enabled, the hostname is always required to be sent in the TLS client hello message. If it is not 
sent, the connection is dropped.
Valid values:
0 - Disabled
1 - Enabled		
										false
										false
										
									

									

										-CopyHdrFrom
                                        
										This is the name of the source header field to copy into the new header field before the request is sent to the Real 
Servers.		
										false
										false
										
									

									

										-CopyHdrTo
                                        
										This parameter is used in conjunction with the CopyHdrFrom parameter.
The name of the header field into which the source header is to be copied.		
										false
										false
										
									

									

										-ServerFbaPath
                                        
										Only relevant when using form-based authentication as the Server Authentication Mode (OutputAuthMode). Set the 
authentication path for server-side Form Based Authentication (FBA). When used in Exchange environments, this does not need 
to be set.		
										false
										false
										
									

									

										-ServerFbaPost
                                        
										Only relevant when using form-based authentication as the Server Athentication Mode (OutputAuthMode). Set the format string 
used to generate POST body for server side FBA. The value must be base64-encoded.
When used in Exchange environments, this does not need to be set.		
										false
										false
										
									

									

										-AddAuthHeader
                                        
										Specify the name of the HTTP header. This header is added to the HTTP request from the LoadMaster to the Real Server and 
its value is set to the user ID for the authenticated session. This option is only available if SAML is selected as the 
InputAuthMode. You can specify up to 255 characters for this parameter.		
										false
										false
										
									

									

										-Intercept
                                        
										Enable or disable the Web Application Firewall (WAF) for this Virtual Service.
										false
										false
										
									

									

										-AllowHTTP2
                                        
										Enable HTTP2 for this Virtual Service. SSL Acceleration must be enabled before HTTP2 can be enabled. The Best Practices 
cipher set should be used when HTTP2 is enabled.		
										false
										false
										
									

									

										-InterceptOpts
                                        
										Specifies Web Application Firewall (WAF) options for this Virtual Service.
The AFP InterceptOpts parameter is a special parameter – it can be used to set the value for multiple fields, rather than 
just one field as with most other parameters. The InterceptOpts parameter allows the specification of most of the fields in 
the WAF Options section of the Virtual Service modify screen in the LoadMaster WUI.
To enable WAF, set the Intercept parameter to 1.
The names of the specific WUI fields that the InterceptOpts parameter is related to are listed in the table below.


One or more field values can be set in one command. Multiple values can be set in the one command by separating the values 
with a semi-colon.
The values that are related to the same WUI option are mutually exclusive. For example, you cannot set Basic Operation to 
both opnormal and opblock.


Value               Related WUI Option                    Default         Meaning
opnormal            Default Operation                     Audit Only      Set the Basic Operation to Audit Only
opblock             Default Operation                     Audit Only      Set the Basic Operation to Block Mode
auditnone           Audit mode                            No Audit        Set the Audit mode to No Audit. No data is logged.
auditrelevant       Audit mode                            No Audit        Set the Audit mode to Audit Relevant. Logs data 
which is of a warning level and higher.
auditall            Audit mode                            No Audit        Set the Audit mode to Audit All. Logs all data 
through the Virtual Service.
The Audit All option is not recommended for use in normal operation.                          Audit All should only be used 
when troubleshooting a specific problem.
reqdataenable       Inspect HTML POST Request Content     Disabled        Enable the Inspect HTML POST Request Content 
option
reqdatadisable      Inspect HTML POST Request Content     Disabled        Disable the Inspect HTML POST Request Content 
option
resdataenable       Process Response Data                 Disabled        Enable the Process Response Data option
resdatadisable      Process Response Data                 Disabled        Disable the Process Response Data option
jsondisable         Enable JSON Parser                    Enabled        Disable the JSON parser. This option is only 
relevant if the Inspect HTML POST Request Content option is enabled.
jsonenable          Enable JSON Parser                    Enabled        Enable the JSON parser. This option is only 
relevant if the Inspect HTML POST Request Content option is enabled.
xmldisable          Enable XML Parser                     Enabled        Disable the XML parser. This option is only 
relevant if the Inspect HTML POST Request Content option is enabled.
xmlenable           Enable XML Parser                     Enabled        Enable the XML parser. This option is only 
relevant if the Inspect HTML POST Request Content option is enabled.
otherctypesdisable  Enable Other Content Types            Disabled       Disable verification of POST content types (other 
than XML/JSON).
otherctypesenable   Enable Other Content Types            Disabled       Enable verification of POST content types (other 
than XML/JSON).
Enabling the inspection of any other content types may increase system resource utilization (CPU and memory). A specific 
list of content types should be considered.
When this option is enabled, the InterceptPOSTOtherContentTypes parameter can be used to enter a comma-separated list of 
POST content types allowed for WAF analysis. By default, all types (other than XML/JSON) are enabled.		
										false
										false
										
									

									

										-InterceptRules
                                        
										Specifies Web Application Firewall (WAF) rules for this Virtual Service.
										false
										false
										
									

									

										-InterceptPostOtherContentTypes
                                        
										When the otherctypesenable option (in the InterceptOpts parameter) is enabled, use the InterceptPOSTOtherContentTypes 
parameter to enter a comma-separated list of POST content types allowed for WAF analysis, for example text/plain,text/css. 
By default, all types (other than XML/JSON) are enabled. To set this to any other content types, set the value to any.


Any content types except text/xml, application/xml, and application/json (which are defined by specific XML and JSON parser 
settings) are allowed to be set for the InterceptPostOtherContentTypes parameter. It may be any valid MIME type in the 
format type/value.


Warning: Enabling the inspection of any other content types may increase system resource utilization (CPU and memory). A 
specific list of content types should be considered.		
										false
										false
										
									

									

										-AlertThreshold
                                        
										Specifies Web Application Firewall (WAF) alert threshold for this Virtual Service.
										false
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-Port
                                        
										The port for the Virtual Service. A wildcard port can also be specified by using an asterisk (*).
The Port parameter is used to assign a port when initially creating a Virtual Service. If modifying the port of an existing 
Virtual Service, specify the existing port as the Port parameter and use the VSPort parameter to assign the new port.
The reason why these must be separate parameters is because you need to specify what the port of the existing Virtual 
Service is (because there may be another Virtual Service with the same IP address but a different port) and if you want to 
change the port, a second port parameter (VSPort) is needed to specify the new port value.		
										false
										false
										
									

									

										-Protocol
                                        
										Specify if the service is using TCP or UDP protocols.
										false
										false
										
									

									

										-DisplayPasswordForm
                                        
										Enabling this option removes the password field from the login page. This may be needed when password validation is not 
required, for example if using RSA SecurID authentication in a singular fashion.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Set-AdcVirtualService -Port 80 -Protocol tcp -VirtualService 10.154.11.90 -persist header

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.
Data field...: @{VS=}
Param........: @{Status=Down; Index=4; VSAddress=10.154.11.90; VSPort=80; Layer=7; Enable=Y; SSLReverse=N; SSLReencrypt=N; 
Intercept=N; InterceptOpts=; 
AlertThreshold=0; Transactionlimit=0; Transparent=N; SubnetOriginating=Y; ServerInit=0; StartTLSMode=0; Idletime=660; 
Cache=N; Compress=N; Verify=0; Use
forSnat=N; ForceL4=N; ForceL7=Y; MultiConnect=N; ClientCert=0; ErrorCode=0; CheckUse1.1=N; MatchLen=0; CheckUseGet=0; 
SSLRewrite=0; VStype=http; FollowV
SID=0; Protocol=tcp; Schedule=rr; CheckType=http; Persist=header; PersistTimeout=360; CheckPort=0; NRules=0; 
NRequestRules=0; NResponseRules=0; NPreProc
essRules=0; EspEnabled=N; InputAuthMode=0; OutputAuthMode=0; MasterVS=0; MasterVSID=0; IsTransparent=2; AddVia=0; QoS=0; 
TlsType=0; NeedHostName=N; OCSP
Verify=N; AllowHTTP2=N; EnhancedHealthChecks=N; RsMinimum=0; NumberOfRSs=0}
Status               : Down
Index                : 4
VSAddress            : 10.154.11.90
VSPort               : 80
Layer                : 7
Enable               : Y
SSLReverse           : N
SSLReencrypt         : N
Intercept            : N
InterceptOpts        : @{Opt=System.Object[]}
AlertThreshold       : 0
Transactionlimit     : 0
Transparent          : N
SubnetOriginating    : Y
ServerInit           : 0
StartTLSMode         : 0
Idletime             : 660
Cache                : N
Compress             : N
Verify               : 0
UseforSnat           : N
ForceL4              : N
ForceL7              : Y
MultiConnect         : N
ClientCert           : 0
ErrorCode            : 0
CheckUse1.1          : N
MatchLen             : 0
CheckUseGet          : 0
SSLRewrite           : 0
VStype               : http
FollowVSID           : 0
Protocol             : tcp
Schedule             : rr
CheckType            : http
Persist              : header
PersistTimeout       : 360
CheckPort            : 0
NRules               : 0
NRequestRules        : 0
NResponseRules       : 0
NPreProcessRules     : 0
EspEnabled           : N
InputAuthMode        : 0
OutputAuthMode       : 0
MasterVS             : 0
MasterVSID           : 0
IsTransparent        : 2
AddVia               : 0
QoS                  : 0
TlsType              : 0
NeedHostName         : N
OCSPVerify           : N
AllowHTTP2           : N
EnhancedHealthChecks : N
RsMinimum            : 0
NumberOfRSs          : 0

                            

						

                        
Top of page
				

				

					

						
 Set-AdminAccess 

						
WARNING: This function is deprecated. Use the following command instead:
Set-SecAdminAccess

						
WARNING: This function is deprecated. Use the following command instead:
Set-SecAdminAccess

					

                        

                        
 Syntax 

                        

						

                            


Set-AdminAccess -WuiNetworkInterfaceId <Int32> -WuiPort <Int32> [-WuiDefaultGateway <String>] [-LoadBalancer <String>] 
[-LBPort <Int32>] [-Credential <Object>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] 
[<CommonParameters>]

Set-AdminAccess -WuiNetworkInterfaceId <Int32> -WuiPort <Int32> [-WuiDefaultGateway <String>] [-LoadBalancer <String>] 
[-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN <String>] [-InformationAction <ActionPreference>] 
[-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-WuiNetworkInterfaceId
                                        
										
										true
										false
										
									

									

										-WuiPort
                                        
										
										true
										false
										
									

									

										-WuiDefaultGateway
                                        
										
										false
										false
										
									

									

										-LoadBalancer
                                        
										
										false
										false
										
									

									

										-LBPort
                                        
										
										false
										false
										
									

									

										-Credential
                                        
										
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										
										false
										false
										
									

									

										-SubjectCN
                                        
										
										false
										false
										
									

								
							

						
				
				

				

					

						
 Set-AFEConfiguration 

						
WARNING: This function is deprecated. Use the following command instead:
Set-LmAFEConfiguration

						
WARNING: This function is deprecated. Use the following command instead:
Set-LmAFEConfiguration

					

                        

                        
 Syntax 

                        

						

                            


Set-AFEConfiguration [-CacheSize <Int32>] [-HostCache <Boolean>] [-DetectionLevel <String>] [-LimitInput <Int64>] 
[-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction <ActionPreference>] 
[-InformationVariable <String>] [<CommonParameters>]

Set-AFEConfiguration [-CacheSize <Int32>] [-HostCache <Boolean>] [-DetectionLevel <String>] [-LimitInput <Int64>] 
[-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN <String>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-CacheSize
                                        
										
										false
										false
										
									

									

										-HostCache
                                        
										
										false
										false
										
									

									

										-DetectionLevel
                                        
										
										false
										false
										
									

									

										-LimitInput
                                        
										
										false
										false
										
									

									

										-LoadBalancer
                                        
										
										false
										false
										
									

									

										-LBPort
                                        
										
										false
										false
										
									

									

										-Credential
                                        
										
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										
										false
										false
										
									

									

										-SubjectCN
                                        
										
										false
										false
										
									

								
							

						
				
				

				

					

						
 Set-AwsHAMode 

						
WARNING: This function is deprecated. Use the following command instead:
Set-LmAwsHAMode

						
WARNING: This function is deprecated. Use the following command instead:
Set-LmAwsHAMode

					

                        

                        
 Syntax 

                        

						

                            


Set-AwsHAMode -HAMode <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Set-AwsHAMode -HAMode <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN 
<String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-HAMode
                                        
										
										true
										false
										
									

									

										-LoadBalancer
                                        
										
										false
										false
										
									

									

										-LBPort
                                        
										
										false
										false
										
									

									

										-Credential
                                        
										
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										
										false
										false
										
									

									

										-SubjectCN
                                        
										
										false
										false
										
									

								
							

						
				
				

				

					

						
 Set-AwsHAOption 

						
WARNING: This function is deprecated. Use the following command instead:
Get-LmAwsHAConfiguration

						
WARNING: This function is deprecated. Use the following command instead:
Get-LmAwsHAConfiguration

					

                        

                        
 Syntax 

                        

						

                            


Set-AwsHAOption [-Partner <String>] [-HealthCheckPort <String>] [-haprefered <Int32>] [-LoadBalancer <String>] [-LBPort 
<Int32>] [-Credential <Object>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Set-AwsHAOption [-Partner <String>] [-HealthCheckPort <String>] [-haprefered <Int32>] [-LoadBalancer <String>] [-LBPort 
<Int32>] [-CertificateStoreLocation <String>] [-SubjectCN <String>] [-InformationAction <ActionPreference>] 
[-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-Partner
                                        
										
										false
										false
										
									

									

										-HealthCheckPort
                                        
										
										false
										false
										
									

									

										-haprefered
                                        
										
										false
										false
										
									

									

										-LoadBalancer
                                        
										
										false
										false
										
									

									

										-LBPort
                                        
										
										false
										false
										
									

									

										-Credential
                                        
										
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										
										false
										false
										
									

									

										-SubjectCN
                                        
										
										false
										false
										
									

								
							

						
				
				

				

					

						
 Set-AzureHAMode 

						
WARNING: This function is deprecated. Use the following command instead:
Set-LmAzureHAMode

						
WARNING: This function is deprecated. Use the following command instead:
Set-LmAzureHAMode

					

                        

                        
 Syntax 

                        

						

                            


Set-AzureHAMode -HAMode <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Set-AzureHAMode -HAMode <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] 
[-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-HAMode
                                        
										
										true
										false
										
									

									

										-LoadBalancer
                                        
										
										false
										false
										
									

									

										-LBPort
                                        
										
										false
										false
										
									

									

										-Credential
                                        
										
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										
										false
										false
										
									

									

										-SubjectCN
                                        
										
										false
										false
										
									

								
							

						
				
				

				

					

						
 Set-AzureHAOption 

						
WARNING: This function is deprecated. Use the following command instead:
Set-AzureHAOption

						
WARNING: This function is deprecated. Use the following command instead:
Set-AzureHAOption

					

                        

                        
 Syntax 

                        

						

                            


Set-AzureHAOption [-Partner <String>] [-Hcp <String>] [-haprefered <Int32>] [-LoadBalancer <String>] [-LBPort <Int32>] 
[-Credential <Object>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Set-AzureHAOption [-Partner <String>] [-Hcp <String>] [-haprefered <Int32>] [-LoadBalancer <String>] [-LBPort <Int32>] 
[-CertificateStoreLocation <String>] [-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable 
<String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-Partner
                                        
										
										false
										false
										
									

									

										-Hcp
                                        
										
										false
										false
										
									

									

										-haprefered
                                        
										
										false
										false
										
									

									

										-LoadBalancer
                                        
										
										false
										false
										
									

									

										-LBPort
                                        
										
										false
										false
										
									

									

										-Credential
                                        
										
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										
										false
										false
										
									

									

										-SubjectCN
                                        
										
										false
										false
										
									

								
							

						
				
				

				

					

						
 Set-BackupOption 

						
WARNING: This function is deprecated. Use the following command instead:
Set-LmBackupConfiguration

						
WARNING: This function is deprecated. Use the following command instead:
Set-LmBackupConfiguration

					

                        

                        
 Syntax 

                        

						

                            


Set-BackupOption [-BackupEnable <String>] [-BackupHour <Int16>] [-BackupMinute <Int16>] [-BackupDay <Int16>] [-BackupMethod 
<String>] [-BackupUser <String>] [-BackupPassword <String>] [-BackupHost <String>] [-BackupPath <String>] [-LoadBalancer 
<String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] 
[<CommonParameters>]

Set-BackupOption [-BackupEnable <String>] [-BackupHour <Int16>] [-BackupMinute <Int16>] [-BackupDay <Int16>] [-BackupMethod 
<String>] [-BackupUser <String>] [-BackupPassword <String>] [-BackupHost <String>] [-BackupPath <String>] [-LoadBalancer 
<String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN <String>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-BackupEnable
                                        
										
										false
										false
										
									

									

										-BackupHour
                                        
										
										false
										false
										
									

									

										-BackupMinute
                                        
										
										false
										false
										
									

									

										-BackupDay
                                        
										
										false
										false
										
									

									

										-BackupMethod
                                        
										
										false
										false
										
									

									

										-BackupUser
                                        
										
										false
										false
										
									

									

										-BackupPassword
                                        
										
										false
										false
										
									

									

										-BackupHost
                                        
										
										false
										false
										
									

									

										-BackupPath
                                        
										
										false
										false
										
									

									

										-LoadBalancer
                                        
										
										false
										false
										
									

									

										-LBPort
                                        
										
										false
										false
										
									

									

										-Credential
                                        
										
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										
										false
										false
										
									

									

										-SubjectCN
                                        
										
										false
										false
										
									

								
							

						
				
				

				

					

						
 Set-DateTimeOption 

						
WARNING: This function is deprecated. Use the following command instead:
Set-LmDateTimeConfiguration

						
WARNING: This function is deprecated. Use the following command instead:
Set-LmDateTimeConfiguration

					

                        

                        
 Syntax 

                        

						

                            


Set-DateTimeOption [-NTPHost <String>] [-TimeZone <String>] [-NTPKeyId <Int32>] [-NTPKeySecret <String>] [-NTPKeyType 
<String>] [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction <ActionPreference>] 
[-InformationVariable <String>] [<CommonParameters>]

Set-DateTimeOption [-NTPHost <String>] [-TimeZone <String>] [-NTPKeyId <Int32>] [-NTPKeySecret <String>] [-NTPKeyType 
<String>] [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN <String>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-NTPHost
                                        
										
										false
										false
										
									

									

										-TimeZone
                                        
										
										false
										false
										
									

									

										-NTPKeyId
                                        
										
										false
										false
										
									

									

										-NTPKeySecret
                                        
										
										false
										false
										
									

									

										-NTPKeyType
                                        
										
										false
										false
										
									

									

										-LoadBalancer
                                        
										
										false
										false
										
									

									

										-LBPort
                                        
										
										false
										false
										
									

									

										-Credential
                                        
										
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										
										false
										false
										
									

									

										-SubjectCN
                                        
										
										false
										false
										
									

								
							

						
				
				

				

					

						
 Set-DebugOption 

						
WARNING: This function is deprecated. Use the following command instead:
Set-LmDebugConfiguration

						
WARNING: This function is deprecated. Use the following command instead:
Set-LmDebugConfiguration

					

                        

                        
 Syntax 

                        

						

                            


Set-DebugOption [-transparent <Boolean>] [-irqbalance <Boolean>] [-linearesplogs <Boolean>] [-netconsole <String>] 
[-netconsoleinterface <Int16>] [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Set-DebugOption [-transparent <Boolean>] [-irqbalance <Boolean>] [-linearesplogs <Boolean>] [-netconsole <String>] 
[-netconsoleinterface <Int16>] [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN 
<String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-transparent
                                        
										
										false
										false
										
									

									

										-irqbalance
                                        
										
										false
										false
										
									

									

										-linearesplogs
                                        
										
										false
										false
										
									

									

										-netconsole
                                        
										
										false
										false
										
									

									

										-netconsoleinterface
                                        
										
										false
										false
										
									

									

										-LoadBalancer
                                        
										
										false
										false
										
									

									

										-LBPort
                                        
										
										false
										false
										
									

									

										-Credential
                                        
										
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										
										false
										false
										
									

									

										-SubjectCN
                                        
										
										false
										false
										
									

								
							

						
				
				

				

					

						
 Set-DNSConfiguration 

						
WARNING: This function is deprecated. Use the following command instead:
Set-NetworkDNSConfiguration

						
WARNING: This function is deprecated. Use the following command instead:
Set-NetworkDNSConfiguration

					

                        

                        
 Syntax 

                        

						

                            


Set-DNSConfiguration [-Hostname <String>] [-HA1Hostname <String>] [-HA2Hostname <String>] [-NameServer <String>] 
[-Searchlist <String>] [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Set-DNSConfiguration [-Hostname <String>] [-HA1Hostname <String>] [-HA2Hostname <String>] [-NameServer <String>] 
[-Searchlist <String>] [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN 
<String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-Hostname
                                        
										
										false
										false
										
									

									

										-HA1Hostname
                                        
										
										false
										false
										
									

									

										-HA2Hostname
                                        
										
										false
										false
										
									

									

										-NameServer
                                        
										
										false
										false
										
									

									

										-Searchlist
                                        
										
										false
										false
										
									

									

										-LoadBalancer
                                        
										
										false
										false
										
									

									

										-LBPort
                                        
										
										false
										false
										
									

									

										-Credential
                                        
										
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										
										false
										false
										
									

									

										-SubjectCN
                                        
										
										false
										false
										
									

								
							

						
				
				

				

					

						
 Set-EmailOption 

						
WARNING: This function is deprecated. Use the following command instead:
Set-LogEmailConfiguration

						
WARNING: This function is deprecated. Use the following command instead:
Set-LogEmailConfiguration

					

                        

                        
 Syntax 

                        

						

                            


Set-EmailOption [-EmailEnable <Boolean>] [-EmailServer <String>] [-EmailPort <Int32>] [-EmailUser <String>] [-EmailPassword 
<String>] [-EmailDomain <String>] [-EmailSSLMode <Int16>] [-EmailEmergency <String>] [-EmailCritical <String>] [-EmailError 
<String>] [-EmailWarn <String>] [-EmailNotice <String>] [-EmailInfo <String>] [-LoadBalancer <String>] [-LBPort <Int32>] 
[-Credential <Object>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Set-EmailOption [-EmailEnable <Boolean>] [-EmailServer <String>] [-EmailPort <Int32>] [-EmailUser <String>] [-EmailPassword 
<String>] [-EmailDomain <String>] [-EmailSSLMode <Int16>] [-EmailEmergency <String>] [-EmailCritical <String>] [-EmailError 
<String>] [-EmailWarn <String>] [-EmailNotice <String>] [-EmailInfo <String>] [-LoadBalancer <String>] [-LBPort <Int32>] 
[-CertificateStoreLocation <String>] [-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable 
<String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-EmailEnable
                                        
										
										false
										false
										
									

									

										-EmailServer
                                        
										
										false
										false
										
									

									

										-EmailPort
                                        
										
										false
										false
										
									

									

										-EmailUser
                                        
										
										false
										false
										
									

									

										-EmailPassword
                                        
										
										false
										false
										
									

									

										-EmailDomain
                                        
										
										false
										false
										
									

									

										-EmailSSLMode
                                        
										
										false
										false
										
									

									

										-EmailEmergency
                                        
										
										false
										false
										
									

									

										-EmailCritical
                                        
										
										false
										false
										
									

									

										-EmailError
                                        
										
										false
										false
										
									

									

										-EmailWarn
                                        
										
										false
										false
										
									

									

										-EmailNotice
                                        
										
										false
										false
										
									

									

										-EmailInfo
                                        
										
										false
										false
										
									

									

										-LoadBalancer
                                        
										
										false
										false
										
									

									

										-LBPort
                                        
										
										false
										false
										
									

									

										-Credential
                                        
										
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										
										false
										false
										
									

									

										-SubjectCN
                                        
										
										false
										false
										
									

								
							

						
				
				

				

					

						
 Set-EspExtendedLogConfiguration 

						
Run this command to enable or disable extended Edge Security Pack (ESP) logging.

						
Enable/disable extended ESP logging.

					

                        

                        
 Syntax 

                        

						

                            


Set-EspExtendedLogConfiguration [-EspExtendedLogEnable <String>] [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential 
<Object>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Set-EspExtendedLogConfiguration [-EspExtendedLogEnable <String>] [-LoadBalancer <String>] [-LBPort <Int32>] 
[-CertificateStoreLocation <String>] [-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable 
<String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-EspExtendedLogEnable
                                        
										Use this parameter to enable or disable ESP extended logging.
no - Disabled
yes - Enabled		
										false
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example


							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.
ReturnCode Response                       Data
---------- --------                       ----
       200 Command successfully executed.

                            

						

                        
Top of page
				

				

					

						
 Set-GeoCluster 

						
Used to change the settings of a cluster.

						
Used to change the settings of a cluster.

					

                        

                        
 Syntax 

                        

						

                            


Set-GeoCluster -ClusterIp <String> [-ClusterName <String>] [-Type <String>] [-Checker <String>] [-CheckerPort <Int32>] 
[-Enable <String>] [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Set-GeoCluster -ClusterIp <String> [-ClusterName <String>] [-Type <String>] [-Checker <String>] [-CheckerPort <Int32>] 
[-Enable <String>] [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN <String>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-ClusterIp
                                        
										The IP address of the cluster.
										true
										false
										
									

									

										-ClusterName
                                        
										Specifies a user account that has permission to administer the load balancer. You can either enter a username for the load 
balancer or provide a PSCredential object, such as an object that is returned by the Get-Credential cmdlet. When you type a 
username, you are prompted for a password.		
										false
										false
										
									

									

										-Type
                                        
										Specify the type of cluster.
Valid values:
 - default
 - remoteLM
 - localLM
Note: The values are case sensitive.		
										false
										false
										
									

									

										-Checker
                                        
										Specify the method used to check the status of the cluster.
none – No checking is performed
tcp – TCP Connect
icmp – ICMP Ping		
										false
										false
										
									

									

										-CheckerPort
                                        
										Set the port used for checking the cluster. This parameter is only relevant if the checker is set to tcp.
										false
										false
										
									

									

										-Enable
                                        
										Enable/disable the cluster.
0 - Disable
1 - Enable		
										false
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Set-GeoCluster –IP 10.34.52.55 -Checker tcp -CheckerPort

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.
Index             : 1
Status            : Up
Name              : ExampleCluster
ClusterVSAddress  : 
IPAddress         : 10.34.52.55
Checker           : tcp
CheckerPort       : 80
Type              : default
Enable            : Y
LocationLatitude  : 
LocationLongitude :

                            

						

                        
Top of page
				

				

					

						
 Set-GeoClusterCoordinates 

						
Allows you to specify the location of a cluster.

						
Allows you to specify the location of a cluster.

					

                        

                        
 Syntax 

                        

						

                            


Set-GeoClusterCoordinates -ClusterIp <String> -LatSecs <Int32> -LongSecs <Int32> [-LoadBalancer <String>] [-LBPort <Int32>] 
[-Credential <Object>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Set-GeoClusterCoordinates -ClusterIp <String> -LatSecs <Int32> -LongSecs <Int32> [-LoadBalancer <String>] [-LBPort <Int32>] 
[-CertificateStoreLocation <String>] [-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable 
<String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-ClusterIp
                                        
										The IP address of the cluster.
										true
										false
										
									

									

										-LatSecs
                                        
										The latitude of the location.
The latsecs and longsecs values should be entered as an integer containing the total seconds. This total seconds value is 
converted to degrees, minutes and seconds when displayed in the WUI. 
There are 60 seconds in a minute and 60 minutes in a degree.
• Degrees = º
• Minutes = ‘
• Seconds = “


• 60” = 1’
• 3600” = 1º
• 3660 = 1º1’
• 3661 = 1º1’1”
You can also represent this as a decimal value for degrees where the minutes and seconds are divided by 3600 to get the 
decimal value.		
										true
										false
										
									

									

										-LongSecs
                                        
										The longitude of the location.
The latsecs and longsecs values should be entered as an integer containing the total seconds. This total seconds value is 
converted to degrees, minutes and seconds when displayed in the WUI. 
There are 60 seconds in a minute and 60 minutes in a degree.
• Degrees = º
• Minutes = ‘
• Seconds = “


• 60” = 1’
• 3600” = 1º
• 3660 = 1º1’
• 3661 = 1º1’1”
You can also represent this as a decimal value for degrees where the minutes and seconds are divided by 3600 to get the 
decimal value.		
										true
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Set-GeoClusterCoordinates –IP 10.34.52.55 -LatSecs 5454 -LongSecs 5222

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed. Cluster location updated; Data=}
Return Code..: 200
Response.....: Command successfully executed. Cluster location updated

                            

						

                        
Top of page
				

				

					

						
 Set-GeoCustomLocation 

						
Used to update an existing custom location.

						
Used to update an existing custom location.

					

                        

                        
 Syntax 

                        

						

                            


Set-GeoCustomLocation -clOldName <String> -clNewName <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential 
<Object>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Set-GeoCustomLocation -clOldName <String> -clNewName <String> [-LoadBalancer <String>] [-LBPort <Int32>] 
[-CertificateStoreLocation <String>] [-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable 
<String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-clOldName
                                        
										The existing name of the custom location. If the custom location name contains two or more words, the name must be 
surrounded by double-quotes such as “New York City”.		
										true
										false
										
									

									

										-clNewName
                                        
										The new name of the custom location. If the custom location name contains two or more words, the name must be surrounded by 
double-quotes such as “New York City”.		
										true
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Set-GeoCustomLocation -clNewName NewExampleLocation -clOldName ExampleLocation

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.

                            

						

                        
Top of page
				

				

					

						
 Set-GeoDNSSECStatus 

						
Enable/disable DNSSEC.

						
Use this command to enable or disable DNSSEC.

					

                        

                        
 Syntax 

                        

						

                            


Set-GeoDNSSECStatus -status <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Set-GeoDNSSECStatus -status <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] 
[-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-status
                                        
										Specify whether to enable or disable DNSSEC. Valid values:
disabled
enabled		
										true
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Set-GeoDNSSECStatus -status enabled

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.

                            

						

                        
Top of page
				

				

					

						
 Set-GeoFQDN 

						
Allows you to update the FQDN settings.

						
Allows you to update the FQDN settings.

					

                        

                        
 Syntax 

                        

						

                            


Set-GeoFQDN -FQDN <String> [-SelectionCriteria <String>] [-SiteFailureDelay <Int32>] [-SiteRecoveryMode <String>] 
[-PublicRequest <String>] [-PrivateRequest <String>] [-Failover <Boolean>] [-LocalSettings <Boolean>] [-localttl <Int32>] 
[-localsticky <Int32>] [-UnanimousChecks <Boolean>] [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Set-GeoFQDN -FQDN <String> [-SelectionCriteria <String>] [-SiteFailureDelay <Int32>] [-SiteRecoveryMode <String>] 
[-PublicRequest <String>] [-PrivateRequest <String>] [-Failover <Boolean>] [-LocalSettings <Boolean>] [-localttl <Int32>] 
[-localsticky <Int32>] [-UnanimousChecks <Boolean>] [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation 
<String>] [-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-FQDN
                                        
										The name of the FQDN. This command cannot change the name of the FQDN - the FQDN name needs to be specified in order to 
modify the other FQDN settings.		
										true
										false
										
									

									

										-SelectionCriteria
                                        
										Specify the selection procedure for addresses associated with the FQDN:
   RoundRobin
   WeightedRoundRobin
   FixedWeighting
   RealServerLoad
   Proximity
   LocationBased
   AllAvailable		
										false
										false
										
									

									

										-SiteFailureDelay
                                        
										If a failure delay is not set, normal health checking is performed. If set, this parameter defines the number of minutes to 
wait after a failure before finally disabling it. Once it is disabled, it will not normally be brought back into operation.
Range: 0-1440 (minutes)
Default: 0		
										false
										false
										
									

									

										-SiteRecoveryMode
                                        
										auto – Upon site recovery, bring the site back into operation immediately.
manual – Once the site has failed, disable the site. Manual intervention is required to restore normal operation.		
										false
										false
										
									

									

										-PublicRequest
                                        
										Restrict responses to clients from public IP addresses to specific classes of site.
   0 – Public Sites Only (default)
   1 – Prefer Public Sites
   2 – Prefer Private Sites
   3 – Any Sites		
										false
										false
										
									

									

										-PrivateRequest
                                        
										Restrict responses to clients from private IP addresses to specific classes of site.
   0 – Private Sites Only (default)
   1 – Prefer Private Sites
   2 – Prefer Public Sites
   3 – Any Sites		
										false
										false
										
									

									

										-Failover
                                        
										This parameter is only relevant if the SelectionCriteria is set to lb (Location Based). Enable/disable FQDN failover.
   0 – Disabled
   1 - Enabled		
										false
										false
										
									

									

										-LocalSettings
                                        
										Enabling this parameter provides two additional parameters for the FQDN – localttl and localsticky.
										false
										false
										
									

									

										-localttl
                                        
										The Time To Live (TTL) value dictates how long the reply from the GEO LoadMaster can be cached by other DNS servers or 
client devices. The time interval is defined in seconds. This value should be as practically low as possible. The default 
value for this field is 10.		
										false
										false
										
									

									

										-localsticky
                                        
										Stickiness, also known as persistence, is the property that enables all name resolution requests from an individual client 
to be sent to the same resources until a specified period of time has elapsed.		
										false
										false
										
									

									

										-UnanimousChecks
                                        
										When this parameter is enabled, if any IP addresses fail health checking - the other FQDN IP addresses which belong to the 
same cluster will be forced down.		
										false
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-FailTime
                                        
										The number of minutes to wait after a failure before disabling. If this is not set, normal health checking is performed.
Range: 0-1440 (minutes)
Default: 0
This is a legacy parameter - use the SiteFailureDelay parameter instead.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Set-GeoFQDN –FQDN Example.com –SelectionCriteria RoundRobin

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.

                            

						

                        
Top of page
				

				

					

						
 Set-GeoFQDNSiteAddress 

						
Allows you to update the details of the map.

						
Allows you to update the details of the map.

					

                        

                        
 Syntax 

                        

						

                            


Set-GeoFQDNSiteAddress -FQDN <String> -SiteAddress <String> [-Checker <String>] [-Weight <Int32>] [-Enable <String>] 
[-Cluster <String>] [-Mapaddress <String>] [-Mapport <String>] [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential 
<Object>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Set-GeoFQDNSiteAddress -FQDN <String> -SiteAddress <String> [-Checker <String>] [-Weight <Int32>] [-Enable <String>] 
[-Cluster <String>] [-Mapaddress <String>] [-Mapport <String>] [-LoadBalancer <String>] [-LBPort <Int32>] 
[-CertificateStoreLocation <String>] [-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable 
<String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-FQDN
                                        
										The name of the FQDN.
										true
										false
										
									

									

										-SiteAddress
                                        
										IPv4 or IPv6 address of the map to be modified.
										true
										false
										
									

									

										-Checker
                                        
										Specify the type of checking to be performed on this IP address. Values are:
   None
   Icmp Ping
   Tcp Connect
   Cluster Checks		
										false
										false
										
									

									

										-Weight
                                        
										This parameter is only relevant when the Selection Criteria is set to Weighted Round Robin or Fixed Weighting. Set the 
weight associated with an IP address. The address with the highest weight is returned.		
										false
										false
										
									

									

										-Enable
                                        
										Enable or disable the IP address.
   0 - Disable
   1 - Enable		
										false
										false
										
									

									

										-Cluster
                                        
										Specify the cluster that is associated with this IP address.
										false
										false
										
									

									

										-Mapaddress
                                        
										This is only relevant when the Selection Criteria is set to Real Server Load, the Checker is set to Cluster Checks and the 
cluster is of type Remote LM or Local LM.
Enter a Virtual Service IP address to be mapped from the relevant LoadMaster.		
										false
										false
										
									

									

										-Mapport
                                        
										This is only relevant when the Selection Criteria is set to Real Server Load, the Checker is set to Cluster Checks and the 
cluster is of type Remote LM or Local LM.
This parameter is used in conjunction with the MapAddress parameter to specify an IP address and port combination to be 
mapped.
If this parameter is not set, the health check will check all Virtual Services with the same IP address as the one 
selected. If one of them is in an “Up” status, the FQDN will show as “Up”. If a port is specified, the health check will 
only check against the health of that Virtual Service when checking the health of the FQDN.		
										false
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Set-GeoFQDNSiteAddress –FQDN Example.com -IP 10.134.33.2 -checker "Icmp Ping"

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.

                            

						

                        
Top of page
				

				

					

						
 Set-GeoFQDNSiteCheckerAddress 

						
Allows you to set the address and port used to health check the IP address.

						
Allows you to set the address and port used to health check the IP address.

					

                        

                        
 Syntax 

                        

						

                            


Set-GeoFQDNSiteCheckerAddress -FQDN <String> -SiteAddress <String> -CheckerIP <String> [-CheckerPort] <String> 
[-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction <ActionPreference>] 
[-InformationVariable <String>] [<CommonParameters>]

Set-GeoFQDNSiteCheckerAddress -FQDN <String> -SiteAddress <String> -CheckerIP <String> [-CheckerPort] <String> 
[-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN <String>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-FQDN
                                        
										The name of the FQDN.
										true
										false
										
									

									

										-SiteAddress
                                        
										The address of the site to change the checker address for.
										true
										false
										
									

									

										-CheckerIP
                                        
										The IP address to be used to health check the IP address. Setting this to an empty string will unset the checker address.
										true
										false
										
									

									

										-CheckerPort
                                        
										The port to be used to health check the IP address. Setting this parameter to an empty string will default the checker port 
to 80.		
										true
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Set-GeoFQDNSiteCheckerAddress -CheckerIP 10.134.44.55 -FQDN Example.com -SiteAddress 10.134.33.2 -Port 80

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.
Status            : Down
SelectionCriteria : RoundRobin
SiteRecoveryMode  : auto
Mapping           : 1
LocalSettings     : 0
UnanimousChecks   : N
Map               : @{Status=Down; Index=1; IPAddress=10.134.33.2; Checker=icmp; CheckerPort=80; CheckerAddr=10.134.44.55; 
Weight=1000; Enable=Y; 
                    LocationLatitude=; LocationLongitude=}
Failover          : N
SiteFailureDelay  : 0
Fqdn              : Example.com.
PrivateRequest    : 0
PublicRequest     : 0

                            

						

                        
Top of page
				

				

					

						
 Set-GeoFQDNSiteCoordinates 

						
Allows you to set the latitude and longitude of an IP address.

						
Allows you to set the latitude and longitude of an IP address when the Selection Criteria of the FQDN is set to Proximity.

					

                        

                        
 Syntax 

                        

						

                            


Set-GeoFQDNSiteCoordinates -FQDN <String> -SiteAddress <String> -Lat <Int32> -Long <Int32> [-LoadBalancer <String>] 
[-LBPort <Int32>] [-Credential <Object>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] 
[<CommonParameters>]

Set-GeoFQDNSiteCoordinates -FQDN <String> -SiteAddress <String> -Lat <Int32> -Long <Int32> [-LoadBalancer <String>] 
[-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN <String>] [-InformationAction <ActionPreference>] 
[-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-FQDN
                                        
										The name of the FQDN.
										true
										false
										
									

									

										-SiteAddress
                                        
										IP address of the map to be modified.
										true
										false
										
									

									

										-Lat
                                        
										The latitude of the IP address in the format of total seconds.
The lat and long values should be entered as an integer containing the total seconds. This total seconds value is converted 
to degrees, minutes and seconds when displayed in the WUI. 
There are 60 seconds in a minute and 60 minutes in a degree.
• Degrees = º
• Minutes = ‘
• Seconds = “


• 60” = 1’
• 3600” = 1º
• 3660 = 1º1’
• 3661 = 1º1’1”
You can also represent this as a decimal value for degrees where the minutes and seconds are divided by 3600 to get the 
decimal value.		
										true
										false
										
									

									

										-Long
                                        
										The longitude of the IP address in the format of total seconds.
The lat and long values should be entered as an integer containing the total seconds. This total seconds value is converted 
to degrees, minutes and seconds when displayed in the WUI. 
There are 60 seconds in a minute and 60 minutes in a degree.
• Degrees = º
• Minutes = ‘
• Seconds = “


• 60” = 1’
• 3600” = 1º
• 3660 = 1º1’
• 3661 = 1º1’1”
You can also represent this as a decimal value for degrees where the minutes and seconds are divided by 3600 to get the 
decimal value.		
										true
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-IP
                                        
										IP address of the map to be modified.
										true
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Set-GeoFQDNSiteCoordinates –FQDN Example.com -IP 10.134.33.2 -Lat 3000 -Long 3000

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed. Map location updated.; Data=}
Return Code..: 200
Response.....: Command successfully executed. Map location updated.

                            

						

                        
Top of page
				

				

					

						
 Set-GeoFQDNSiteCountry 

						
Assign a country/continent to an IP address.

						
Assigns a country or continent to an IP address in an FQDN which has the Selection Criteria set to Location Based.

					

                        

                        
 Syntax 

                        

						

                            


Set-GeoFQDNSiteCountry -FQDN <String> -SiteAddress <String> [-CountryCode <String>] [-IsContinent <String>] 
[-CustomLocation <String>] [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Set-GeoFQDNSiteCountry -FQDN <String> -SiteAddress <String> [-CountryCode <String>] [-IsContinent <String>] 
[-CustomLocation <String>] [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN 
<String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-FQDN
                                        
										The name of the FQDN.
										true
										false
										
									

									

										-SiteAddress
                                        
										The address of the map to be modified.
										true
										false
										
									

									

										-CountryCode
                                        
										Two-letter country or continent code for the country/continent to be assigned.
The country code and continent codes used are the standard ISO codes.
To specify everywhere as the country, type ALL as the country code and set the IsContinent parameter to yes.		
										false
										false
										
									

									

										-IsContinent
                                        
										Some country codes and continent codes are the same, for example AF could mean Africa or Afghanistan. You must specify in 
this parameter if the code is for a country or continent.
yes – code is for a continent
no – code is for a country		
										false
										false
										
									

									

										-CustomLocation
                                        
										The name of an existing custom location.
										false
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Set-GeoFQDNSiteCountry -FQDN Example.com -SiteAddress 10.134.33.2 -CountryCode IE -IsContinent no

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed. Country/Continent updated.; Data=}
Return Code..: 200
Response.....: Command successfully executed. Country/Continent updated.

                            

						

                        
Top of page
				

				

					

						
 Set-GeoFQDNSiteMapping 

						
Allows you to change the remote virtual ip address in the mapping menu.

						
Allows you to change the remote virtual ip address in the mapping menu.

					

                        

                        
 Syntax 

                        

						

                            


Set-GeoFQDNSiteMapping -FQDN <String> [-SiteAddress <String>] [-SiteAddressId <Int32>] [-MappingIp <String>] [-MappingPort 
<Int32>] [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction <ActionPreference>] 
[-InformationVariable <String>] [<CommonParameters>]

Set-GeoFQDNSiteMapping -FQDN <String> [-SiteAddress <String>] [-SiteAddressId <Int32>] [-MappingIp <String>] [-MappingPort 
<Int32>] [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN <String>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-FQDN
                                        
										The name of the FQDN.
										true
										false
										
									

									

										-SiteAddress
                                        
										The FQDN site ip address.
										false
										false
										
									

									

										-SiteAddressId
                                        
										The FQDN site ip ID.
										false
										false
										
									

									

										-MappingIp
                                        
										The ip address of the map.
										false
										false
										
									

									

										-MappingPort
                                        
										The port of the mapped ip address. This parameter only accepts integer values.
										false
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.Specify the 
port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
				

				

					

						
 Set-GeoIPBlacklistDatabaseConfiguration 

						
Configure the GEO IP blacklist database settings.

						
This command can be run to set the GEO IP blacklist database settings, such as:
- The auto-update time
- The auto-install setting
- The auto-install time

					

                        

                        
 Syntax 

                        

						

                            


Set-GeoIPBlacklistDatabaseConfiguration -DatabaseAutoUpdate <SwitchParameter> [-LoadBalancer <String>] [-LBPort <Int32>] 
[-Credential <Object>] [-CertificateStoreLocation <String>] [-SubjectCN <String>] [-InformationAction <ActionPreference>] 
[-InformationVariable <String>] [<CommonParameters>]

Set-GeoIPBlacklistDatabaseConfiguration [-DatabaseAutoInstall <SwitchParameter>] [-DatabaseInstallTimeHour <Int32>] 
[-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-CertificateStoreLocation <String>] [-SubjectCN 
<String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-DatabaseAutoUpdate
                                        
										Enable or disable automatic downloading of updates.
										true
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-DatabaseAutoInstall
                                        
										Enable or disable automatic installation of the updates.
										false
										false
										
									

									

										-DatabaseInstallTimeHour
                                        
										Set the time of the automatic installation. The hour is the hour value from the 24-hour clock (0-23), for example 13 is 1pm.
										false
										false
										
									

								
							

						
				
						

                            

                                
 Note 

                            

							
You can only use one login method - either certificate or credential. You cannot use both.

						

                        

                            
 Examples 

                        

						

                            

							    Example

Set-GeoIPBlacklistDatabaseConfiguration -DatabaseAutoInstall -DatabaseInstallTimeHour 14

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.

                            

						

                        
Top of page
				

				

					

						
 Set-GeoIPRangeCoordinates 

						
Allows you to change the location of an IP address.

						
Allows you to change the location of an IP address.

					

                        

                        
 Syntax 

                        

						

                            


Set-GeoIPRangeCoordinates -IP <String> -Lat <Int32> -Long <Int32> [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential 
<Object>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Set-GeoIPRangeCoordinates -IP <String> -Lat <Int32> -Long <Int32> [-LoadBalancer <String>] [-LBPort <Int32>] 
[-CertificateStoreLocation <String>] [-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable 
<String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-IP
                                        
										The IP address to be modified.
										true
										false
										
									

									

										-Lat
                                        
										The latitude of the location. This parameter accepts values from -324000 (which converts to 90 degrees south) to 324000 
(which converts to 90 degrees north).
The lat and long values should be entered as an integer containing the total seconds. This total seconds value is converted 
to degrees, minutes and seconds when displayed in the WUI. 
There are 60 seconds in a minute and 60 minutes in a degree.
• Degrees = º
• Minutes = ‘
• Seconds = “


• 60” = 1’
• 3600” = 1º
• 3660 = 1º1’
• 3661 = 1º1’1”
You can also represent this as a decimal value for degrees where the minutes and seconds are divided by 3600 to get the 
decimal value.		
										true
										false
										
									

									

										-Long
                                        
										The longitude of the location. This parameter accepts values from -648000 (which converts to 180 degrees East) to 648000 
which converts to 180 degrees West).
The lat and long values should be entered as an integer containing the total seconds. This total seconds value is converted 
to degrees, minutes and seconds when displayed in the WUI. 
There are 60 seconds in a minute and 60 minutes in a degree.
• Degrees = º
• Minutes = ‘
• Seconds = “


• 60” = 1’
• 3600” = 1º
• 3660 = 1º1’
• 3661 = 1º1’1”
You can also represent this as a decimal value for degrees where the minutes and seconds are divided by 3600 to get the 
decimal value.		
										true
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Set-GeoIPRangeCoordinates –IP 10.154.11.55 -Lat 5875 -Long 6565

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed. IP range location updated; Data=}
Return Code..: 200
Response.....: Command successfully executed. IP range location updated

                            

						

                        
Top of page
				

				

					

						
 Set-GeoIPRangeCountry 

						
Assigns a country to an IP address.

						
Assigns a country to an IP address.

					

                        

                        
 Syntax 

                        

						

                            


Set-GeoIPRangeCountry -IP <String> -CountryCode <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Set-GeoIPRangeCountry -IP <String> -CountryCode <String> [-LoadBalancer <String>] [-LBPort <Int32>] 
[-CertificateStoreLocation <String>] [-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable 
<String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-IP
                                        
										The IP address to be modified.
										true
										false
										
									

									

										-CountryCode
                                        
										Two-character country code, for example IE is Ireland.
										true
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Set-GeoIPRangeCountry –CountryCode US -IP 10.154.11.55

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed. IP range country updated; Data=}
Return Code..: 200
Response.....: Command successfully executed. IP range country updated

                            

						

                        
Top of page
				

				

					

						
 Set-GeoIPRangeCustomLocation 

						
Assigns a custom location to an IP address.

						
Assigns a custom location to an IP address.

					

                        

                        
 Syntax 

                        

						

                            


Set-GeoIPRangeCustomLocation -IP <String> -CustomLoc <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential 
<Object>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Set-GeoIPRangeCustomLocation -IP <String> -CustomLoc <String> [-LoadBalancer <String>] [-LBPort <Int32>] 
[-CertificateStoreLocation <String>] [-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable 
<String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-IP
                                        
										The IP address to be modified.
										true
										false
										
									

									

										-CustomLoc
                                        
										The name of an existing custom location.
										true
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Set-GeoIPRangeCustomLocation -CustomLoc "US West" -IP 10.11.0.14

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed. IP range country updated; Data=}
Return Code..: 200
Response.....: Command successfully executed. IP range country updated

                            

						

                        
Top of page
				

				

					

						
 Set-GeoMiscParameter 

						
Update the miscellaneous GEO parameters.

						
Update the miscellaneous GEO parameters, such as those relating to the Source of Authority, Resource Check Parameters and 
Stickiness.

					

                        

                        
 Syntax 

                        

						

                            


Set-GeoMiscParameter [-SourceOfAuthority <String>] [-NameSrv <String>] [-SOAEmail <String>] [-TTL <Int32>] [-Persist 
<Int32>] [-CheckInterval <Int32>] [-ConnTimeout <Int32>] [-RetryAttempts <Int32>] [-Zone <String>] [-LoadBalancer <String>] 
[-LBPort <Int32>] [-Credential <Object>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] 
[<CommonParameters>]

Set-GeoMiscParameter [-SourceOfAuthority <String>] [-NameSrv <String>] [-SOAEmail <String>] [-TTL <Int32>] [-Persist 
<Int32>] [-CheckInterval <Int32>] [-ConnTimeout <Int32>] [-RetryAttempts <Int32>] [-Zone <String>] [-LoadBalancer <String>] 
[-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN <String>] [-InformationAction <ActionPreference>] 
[-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-SourceOfAuthority
                                        
										Specify the response set for Source Of Authority requests.
										false
										false
										
									

									

										-NameSrv
                                        
										Specify the response set for Name Server requests
										false
										false
										
									

									

										-SOAEmail
                                        
										Specify the response email string sent for SOA requests.
										false
										false
										
									

									

										-TTL
                                        
										Specify the Time To Live (TTL) of the responses returned by the LoadMaster. The default value for this is 10.
The range is 1-86400.		
										false
										false
										
									

									

										-Persist
                                        
										This parameter corresponds to the Stickiness field in the WUI. Specify how long a specific request will be returned to a 
host.		
										false
										false
										
									

									

										-CheckInterval
                                        
										Specify how often to check the devices.
Range: 9-3600
Note: The interval value must be greater than the ConnTimeout value multiplied by the RetryAttempts value (Interval > 
Timeout * Retry + 1). 
      This is to ensure that the next health check does not start before the previous one completes. 
      If the timeout or retry values are increased to a value that breaks this rule, the interval value will be 
automatically increased.		
										false
										false
										
									

									

										-ConnTimeout
                                        
										Specify the timeout value for the check request.
Range: 4-60		
										false
										false
										
									

									

										-RetryAttempts
                                        
										Specify the number of times the check will be retried before the device is marked as failed.
										false
										false
										
									

									

										-Zone
                                        
										Specify the zone name.
										false
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Set-GeoMiscParameter -ConnTimeout 50

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.
soa   : @{TTL=10; persist=60; Zone=; SourceOfAuthority=; NameSrv=; SOAEmail=}
check : @{CheckInterval=120; ConnTimeout=50; RetryAttempts=2}

                            

						

                        
Top of page
				

				

					

						
 Set-HAOption 

						
WARNING: This function is deprecated. Use the following command instead:
Set-LmHAConfiguration

						
WARNING: This function is deprecated. Use the following command instead:
Set-LmHAConfiguration

					

                        

                        
 Syntax 

                        

						

                            


Set-HAOption [-hatimeout <Int16>] [-hawait <Int16>] [-havhid <Int16>] [-haprefered <String>] [-haif <Int16>] [-hal4update 
<Boolean>] [-hal7update <Boolean>] [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Set-HAOption [-hatimeout <Int16>] [-hawait <Int16>] [-havhid <Int16>] [-haprefered <String>] [-haif <Int16>] [-hal4update 
<Boolean>] [-hal7update <Boolean>] [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] 
[-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-hatimeout
                                        
										
										false
										false
										
									

									

										-hawait
                                        
										
										false
										false
										
									

									

										-havhid
                                        
										
										false
										false
										
									

									

										-haprefered
                                        
										
										false
										false
										
									

									

										-haif
                                        
										
										false
										false
										
									

									

										-hal4update
                                        
										
										false
										false
										
									

									

										-hal7update
                                        
										
										false
										false
										
									

									

										-LoadBalancer
                                        
										
										false
										false
										
									

									

										-LBPort
                                        
										
										false
										false
										
									

									

										-Credential
                                        
										
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										
										false
										false
										
									

									

										-SubjectCN
                                        
										
										false
										false
										
									

								
							

						
				
				

				

					

						
 Set-Interface 

						
WARNING: This function is deprecated. Use the following command instead:
Set-NetworkInterface

						
WARNING: This function is deprecated. Use the following command instead:
Set-NetworkInterface

					

                        

                        
 Syntax 

                        

						

                            


Set-Interface [-InterfaceID <Int16>] [-IPAddress <String>] [-MTU <Int32>] [-HACheck <Boolean>] [-GWIface <Boolean>] 
[-clupdate <Boolean>] [-GeoTraffic <Boolean>] [-BondMode <String>] [-Partner <String>] [-Shared <String>] [-LoadBalancer 
<String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] 
[<CommonParameters>]

Set-Interface [-InterfaceID <Int16>] [-IPAddress <String>] [-MTU <Int32>] [-HACheck <Boolean>] [-GWIface <Boolean>] 
[-clupdate <Boolean>] [-GeoTraffic <Boolean>] [-BondMode <String>] [-Partner <String>] [-Shared <String>] [-LoadBalancer 
<String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN <String>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-InterfaceID
                                        
										
										false
										false
										
									

									

										-IPAddress
                                        
										
										false
										false
										
									

									

										-MTU
                                        
										
										false
										false
										
									

									

										-HACheck
                                        
										
										false
										false
										
									

									

										-GWIface
                                        
										
										false
										false
										
									

									

										-clupdate
                                        
										
										false
										false
										
									

									

										-GeoTraffic
                                        
										
										false
										false
										
									

									

										-BondMode
                                        
										
										false
										false
										
									

									

										-Partner
                                        
										
										false
										false
										
									

									

										-Shared
                                        
										
										false
										false
										
									

									

										-LoadBalancer
                                        
										
										false
										false
										
									

									

										-LBPort
                                        
										
										false
										false
										
									

									

										-Credential
                                        
										
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										
										false
										false
										
									

									

										-SubjectCN
                                        
										
										false
										false
										
									

								
							

						
				
				

				

					

						
 Set-L7Configuration 

						
WARNING: This function is deprecated. Use the following command instead:
Set-AdcL7Configuration

						
WARNING: This function is deprecated. Use the following command instead:
Set-AdcL7Configuration

					

                        

                        
 Syntax 

                        

						

                            


Set-L7Configuration [-ScalingOver64KConnections <Boolean>] [-AlwaysCheckPersist <String>] [-AddPortToActiveCookie 
<Boolean>] [-RFCConform <Boolean>] [-CloseOnError <Boolean>] [-AddViaHeaderInCacheResponses <Boolean>] [-RSAreLocal 
<Boolean>] [-DropOnRSFail <Boolean>] [-DropAtDrainEnd <Boolean>] [-L7AuthTimeoutSecs <Int16>] [-L7ClientTokenTimeoutSecs 
<Int16>] [-L7ConnectionDrainTimeoutSecs <Int32>] [-AdditionalL7Header <String>] [-OneHundredContinueHandling <String>] 
[-AllowEmptyPosts <Boolean>] [-AllowEmptyHttpHeaders <Boolean>] [-ForceCompleteRSMatch <Boolean>] [-SlowStart <Int16>] 
[-ShareSubVSPersistance <Boolean>] [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Set-L7Configuration [-ScalingOver64KConnections <Boolean>] [-AlwaysCheckPersist <String>] [-AddPortToActiveCookie 
<Boolean>] [-RFCConform <Boolean>] [-CloseOnError <Boolean>] [-AddViaHeaderInCacheResponses <Boolean>] [-RSAreLocal 
<Boolean>] [-DropOnRSFail <Boolean>] [-DropAtDrainEnd <Boolean>] [-L7AuthTimeoutSecs <Int16>] [-L7ClientTokenTimeoutSecs 
<Int16>] [-L7ConnectionDrainTimeoutSecs <Int32>] [-AdditionalL7Header <String>] [-OneHundredContinueHandling <String>] 
[-AllowEmptyPosts <Boolean>] [-AllowEmptyHttpHeaders <Boolean>] [-ForceCompleteRSMatch <Boolean>] [-SlowStart <Int16>] 
[-ShareSubVSPersistance <Boolean>] [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] 
[-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-ScalingOver64KConnections
                                        
										
										false
										false
										
									

									

										-AlwaysCheckPersist
                                        
										
										false
										false
										
									

									

										-AddPortToActiveCookie
                                        
										
										false
										false
										
									

									

										-RFCConform
                                        
										
										false
										false
										
									

									

										-CloseOnError
                                        
										
										false
										false
										
									

									

										-AddViaHeaderInCacheResponses
                                        
										
										false
										false
										
									

									

										-RSAreLocal
                                        
										
										false
										false
										
									

									

										-DropOnRSFail
                                        
										
										false
										false
										
									

									

										-DropAtDrainEnd
                                        
										
										false
										false
										
									

									

										-L7AuthTimeoutSecs
                                        
										
										false
										false
										
									

									

										-L7ClientTokenTimeoutSecs
                                        
										
										false
										false
										
									

									

										-L7ConnectionDrainTimeoutSecs
                                        
										
										false
										false
										
									

									

										-AdditionalL7Header
                                        
										
										false
										false
										
									

									

										-OneHundredContinueHandling
                                        
										
										false
										false
										
									

									

										-AllowEmptyPosts
                                        
										
										false
										false
										
									

									

										-AllowEmptyHttpHeaders
                                        
										
										false
										false
										
									

									

										-ForceCompleteRSMatch
                                        
										
										false
										false
										
									

									

										-SlowStart
                                        
										
										false
										false
										
									

									

										-ShareSubVSPersistance
                                        
										
										false
										false
										
									

									

										-LoadBalancer
                                        
										
										false
										false
										
									

									

										-LBPort
                                        
										
										false
										false
										
									

									

										-Credential
                                        
										
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										
										false
										false
										
									

									

										-SubjectCN
                                        
										
										false
										false
										
									

								
							

						
				
				

				

					

						
 Set-LdapEndpoint 

						
Modify an existing LDAP endpoint.

						
These LDAP endpoints may be used in three different areas:
• Health checks
• SSO domains
• WUI authentication

					

                        

                        
 Syntax 

                        

						

                            


Set-LdapEndpoint -Name <String> [-Server <String>] [-LdapProtocol <String>] [-VInterval <Int16>] [-ReferralCount <Int16>] 
[-Timeout <Int16>] [-AdminUser <String>] [-AdminPass <String>] [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential 
<Object>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Set-LdapEndpoint -Name <String> [-Server <String>] [-LdapProtocol <String>] [-VInterval <Int16>] [-ReferralCount <Int16>] 
[-Timeout <Int16>] [-AdminUser <String>] [-AdminPass <String>] [-LoadBalancer <String>] [-LBPort <Int32>] 
[-CertificateStoreLocation <String>] [-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable 
<String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-Name
                                        
										The name of the LDAP endpoint to be modified.
										true
										false
										
									

									

										-Server
                                        
										Specify the address, or addresses, of the LDAP server to be used. You can also specify a port number, if desired. Separate 
multiple addresses with a space.		
										false
										false
										
									

									

										-LdapProtocol
                                        
										Specify the transport protocol to use when communicating with the LDAP server.
Valid values:
0 – Unencrypted (default)
1 – StartTLS
2 – LDAPS		
										false
										false
										
									

									

										-VInterval
                                        
										Specify how often to revalidate the user the with the LDAP server. 
Range:
10 – 86400 seconds
Default: 60		
										false
										false
										
									

									

										-ReferralCount
                                        
										Multiple hops may increase authentication latency. There is a performance impact that depends on the number and depth of 
referrals required in your configuration.
You must have intimate knowledge of your Active Directory structure to set the referral limit appropriately. The same 
credentials are used for all lookups, and so on.
The use of Active Directory Global Catalog (GC) is the preferred configuration as the primary means of resolution instead 
of enabling LDAP referral chasing. A GC query can be used to query the GC cache instead of relying on LDAP and the referral 
process. Using Active Directory GC has little or no performance drag on the LoadMaster. For steps on how to add/remove the 
GC, refer to the following TechNet article: https://technet.microsoft.com/en-us/library/cc755257(v=ws.11).aspx		
										false
										false
										
									

									

										-Timeout
                                        
										Specify the LDAP server timeout in seconds. The default value is 5. Valid values range from 5 to 60.
										false
										false
										
									

									

										-AdminUser
                                        
										Specify the username of an administrator user. The username that will be used to check the LDAP server.
										false
										false
										
									

									

										-AdminPass
                                        
										Specify the password for the specified administrator user. The password that will be used to check the LDAP server.
										false
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Set-LdapEndpoint -Name ExampleLDAPEndpoint -Server "10.154.11.24 10.154.22.45"

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.

                            

						

                        
Top of page
				

				

					

						
 Set-LicenseInitialPassword 

						
Set the password for the default bal LoadMaster user when initially configuring the LoadMaster.

						
Set the password for the default bal LoadMaster user when initially configuring the LoadMaster.

					

                        

                        
 Syntax 

                        

						

                            


Set-LicenseInitialPassword [-Passwd] <String> [[-LoadBalancer] <String>] [[-LBPort] <Int32>] [[-Credential] <Object>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-Passwd
                                        
										The desired password for the default bal LoadMaster user.
										true
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Set-LicenseInitialPassword -Passwd 2fourall

							    
Example Output:
Full response: Command successfully executed.
Return Code..: 200
Response.....: Command successfully executed
Data field...:

                            

						

                        
Top of page
				

				

					

						
 Set-LmAFEConfiguration 

						
Allows you to set the values of Cache, Compression and IPS options.

						
Allows you to set the values of Cache, Compression and IPS options.

					

                        

                        
 Syntax 

                        

						

                            


Set-LmAFEConfiguration [-CacheSize <Int32>] [-HostCache <Boolean>] [-DetectionLevel <String>] [-LimitInput <Int64>] 
[-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction <ActionPreference>] 
[-InformationVariable <String>] [<CommonParameters>]

Set-LmAFEConfiguration [-CacheSize <Int32>] [-HostCache <Boolean>] [-DetectionLevel <String>] [-LimitInput <Int64>] 
[-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN <String>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-CacheSize
                                        
										Specifies the cache size.
										false
										false
										
									

									

										-HostCache
                                        
										Enable or disable using the host cache.
										false
										false
										
									

									

										-DetectionLevel
                                        
										Specify how paranoid the detection rules should be. Valid options are:
Low - Only logging, no rejection
Default - Only Critical problems are rejected
High - Serious and Critical problems are rejected
Paranoid - All problems detected are rejected		
										false
										false
										
									

									

										-LimitInput
                                        
										Limit the number of connections.
										false
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-Paranoia
                                        
										Sets the sensitivity of IDS detection.
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Set-LmAFEConfiguration -CacheSize 150 -HostCache $True -LimitInput 10 -Paranoia 2

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.

                            

						

                        
Top of page
				

				

					

						
 Set-LmAwsHAConfiguration 

						
Set the Amazon Web Services (AWS) High Availability (HA) options.

						
Set the AWS HA options, such as the health check port and partner address.

					

                        

                        
 Syntax 

                        

						

                            


Set-LmAwsHAConfiguration [-Partner <String>] [-HealthCheckPort <String>] [-haprefered <Int32>] [-HealthCheckAllInterfaces 
<String>] [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction <ActionPreference>] 
[-InformationVariable <String>] [<CommonParameters>]

Set-LmAwsHAConfiguration [-Partner <String>] [-HealthCheckPort <String>] [-haprefered <Int32>] [-HealthCheckAllInterfaces 
<String>] [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN <String>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-Partner
                                        
										Address of the HA partner.
										false
										false
										
									

									

										-HealthCheckPort
                                        
										The port over which the health check is run. This needs to be the same on both the master and the slave units in order for 
HA to function correctly.		
										false
										false
										
									

									

										-haprefered
                                        
										There are two possible values to set:
0 - No Preferred Host: Each unit takes over when the other unit fails. No switchover is performed when the partner is 
restarted.
1 - Prefer Master: The HA1 (master) unit always takes over. This is the default option.		
										false
										false
										
									

									

										-HealthCheckAllInterfaces
                                        
										When this option is enabled, the health check listens on all interfaces. This is required when using a multi-arm 
configuration. If this is disabled, the health check listens on the primary eth0 address (this is the default behavior).
no - Disabled
yes - Enabled		
										false
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-Hcp
                                        
										The port over which the health check is run. This needs to be the same on both the master and the slave units in order for 
HA to function correctly.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Set-ClusterAwsHAConfiguration –Hcp 443 –Partner 10.141.44.22

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.
Hcp: 443

                            

						

                        
Top of page
				

				

					

						
 Set-LmAwsHAMode 

						
Allows you to specify the Amazon Web Services (AWS) HA mode.

						
Allows you to specify the Amazon Web Services (AWS) HA mode, for example, master HA Mode, slave HA Mode or Non-HA mode.

					

                        

                        
 Syntax 

                        

						

                            


Set-LmAwsHAMode -HAMode <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Set-LmAwsHAMode -HAMode <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] 
[-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-HAMode
                                        
										Specifies the HA mode. Valid values are:
   - master
   - slave
   - single		
										true
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Set-LmAwsHAMode –HAMode master

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.

                            

						

                        
Top of page
				

				

					

						
 Set-LmAzureHAConfiguration 

						
Configure the HA options for an Azure LoadMaster.

						
Allows you to set the other Azure HA options: health check port and partner address. Run this command on the master 
LoadMaster.

					

                        

                        
 Syntax 

                        

						

                            


Set-LmAzureHAConfiguration [-Partner <String>] [-HealthCheckPort <String>] [-Hapreferred <Int32>] 
[-HealthCheckAllInterfaces <String>] [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Set-LmAzureHAConfiguration [-Partner <String>] [-HealthCheckPort <String>] [-Hapreferred <Int32>] 
[-HealthCheckAllInterfaces <String>] [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] 
[-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-Partner
                                        
										The internal IP address of the HA partner.
										false
										false
										
									

									

										-HealthCheckPort
                                        
										Set the port over which the health check will be run. The port must be the same on both the master and slave unit for HA to 
function correctly.		
										false
										false
										
									

									

										-Hapreferred
                                        
										Setting this parameter to No Preferred Host (0), means that when a machine restarts after a switchover, that machine 
becomes a slave.
Specifying a preferred host means that when this machine restarts it always becomes the master and the partner reverts to 
slave mode.
There are two possible values to set:
0 - No Preferred Host: Each unit takes over when the other unit fails. No switchover is performed when the partner is 
restarted.
1 - Prefer Master: The HA1 (master) unit always takes over. This is the default option.		
										false
										false
										
									

									

										-HealthCheckAllInterfaces
                                        
										When this option is enabled, the health check listens on all interfaces. This is required when using a multi-arm 
configuration. If this is disabled, the health check listens on the primary eth0 address (this is the default behavior).
no - Disabled
yes - Enabled		
										false
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-haprefered
                                        
										There are two possible values to set:
0 - No Preferred Host: Each unit takes over when the other unit fails. No switchover is performed when the partner is 
restarted.
1 - Prefer Master: The HA1 (master) unit always takes over. This is the default option.		
										false
										false
										
									

									

										-Hcp
                                        
										The port over which the health check is run. This needs to be the same on both the master and the slave units in order for 
HA to function correctly.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Set-ClusterAzureHAConfiguration –HealthCheckPort 8443

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.
Hcp: 8443

                            

						

                        
Top of page
				

				

					

						
 Set-LmAzureHAMode 

						
Allows you to specify the Azure HA mode.

						
Allows you to specify the Azure HA mode. For example, Master HA Mode, Slave HA Mode or Non-HA Mode (single).

					

                        

                        
 Syntax 

                        

						

                            


Set-LmAzureHAMode -HAMode <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Set-LmAzureHAMode -HAMode <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] 
[-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-HAMode
                                        
										Specifies the HA mode. Valid options are master, slave or single.
										true
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Set-ClusterAzureHAMode –HAMode master

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.

                            

						

                        
Top of page
				

				

					

						
 Set-LmBackupConfiguration 

						
Allows you to set the values of the Automated Backup options.

						
Allows you to set the values of the Automated Backup options.

					

                        

                        
 Syntax 

                        

						

                            


Set-LmBackupConfiguration [-BackupEnable <String>] [-BackupHour <Int16>] [-BackupMinute <Int16>] [-BackupDay <Int16>] 
[-BackupMethod <String>] [-BackupUser <String>] [-BackupPassword <String>] [-BackupHost <String>] [-BackupPath <String>] 
[-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction <ActionPreference>] 
[-InformationVariable <String>] [<CommonParameters>]

Set-LmBackupConfiguration [-BackupEnable <String>] [-BackupHour <Int16>] [-BackupMinute <Int16>] [-BackupDay <Int16>] 
[-BackupMethod <String>] [-BackupUser <String>] [-BackupPassword <String>] [-BackupHost <String>] [-BackupPath <String>] 
[-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN <String>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-BackupEnable
                                        
										Specifies if scheduled backups are enabled.
										false
										false
										
									

									

										-BackupHour
                                        
										For scheduled backups, this parameter specifies the "hour" number (0-23).
										false
										false
										
									

									

										-BackupMinute
                                        
										For scheduled backups, this parameter specifies the "minute" number (0-59).
										false
										false
										
									

									

										-BackupDay
                                        
										For scheduled backups, this parameter specifies the "day" number (0-7).
										false
										false
										
									

									

										-BackupMethod
                                        
										Specify the file transfer method for automated backups. Valid values are:
Ftp
SCP
sftp		
										false
										false
										
									

									

										-BackupUser
                                        
										Specifies the user account that has access to save the backup file.
										false
										false
										
									

									

										-BackupPassword
                                        
										Specifies the password for the user account that has access to save the backup file.
										false
										false
										
									

									

										-BackupHost
                                        
										Specifies the host to save the backup file to.
										false
										false
										
									

									

										-BackupPath
                                        
										Specifies the path on the remote host for saving the backup file.
										false
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Set-LmBackupConfiguration -BackupEnable yes

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.
Data field...: @{Parameters=}
Param........: @{backupenable=yes}
backupenable : yes

                            

						

                        
Top of page
				

				

					

						
 Set-LmBackupSecureIdentity 

						
If using scp as the BackupMethod, use this command to upload the remote identity value.

						
This is the SSH private key generated using ssh-keygen on the remote scp server.


The key file must be encoded in base64 before uploading.


Note: SSH private keys up to 6144 bits in size are supported.

					

                        

                        
 Syntax 

                        

						

                            


Set-LmBackupSecureIdentity -Path <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Set-LmBackupSecureIdentity -Path <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] 
[-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-Path
                                        
										The path to the private key file, in the format <Path>\<Filename.Extension>, for example C:\t\PrivateKeyExample.ppk.
										true
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Set-LmBackupSecureIdentity -Path C:\t\PrivateKeyExample.ppk

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.

                            

						

                        
Top of page
				

				

					

						
 Set-LmCloudHaConfiguration 

						
Set the Cloud High Availability (HA) parameters.

						
Configure the HA parameters, such as the partner IP address and health check port.

					

                        

                        
 Syntax 

                        

						

                            


Set-LmCloudHaConfiguration [-Partner <String>] [-HealthCheckPort <String>] [-Hapreferred <Int32>] 
[-HealthCheckAllInterfaces <String>] [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Set-LmCloudHaConfiguration [-Partner <String>] [-HealthCheckPort <String>] [-Hapreferred <Int32>] 
[-HealthCheckAllInterfaces <String>] [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] 
[-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-Partner
                                        
										Specify the host name or IP address of the HA partner unit.
										false
										false
										
									

									

										-HealthCheckPort
                                        
										Set the port over which the health check will be run. The port must be the same on both the active and standby unit for HA 
to function correctly.		
										false
										false
										
									

									

										-Hapreferred
                                        
										There are two possible values to set:
0 - No Preferred Host: Each unit takes over when the other unit fails. No switchover is performed when the partner is 
restarted.
1 - Prefer Master: You use the Set-LmCloudHaMode command to specifcy which LoadMaster is in first or second mode. If the 
Hapreferred parameter is sect to 1 - Prefer Master, the first (active) unit always takes over. This is the default option.		
										false
										false
										
									

									

										-HealthCheckAllInterfaces
                                        
										When this option is enabled, the health check listens on all interfaces. This is required when using a multi-arm 
configuration. If this is disabled, the health check listens on the primary eth0 address (this is the default behavior).		
										false
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Set-LmCloudHaConfiguration -HealthCheckAllInterfaces yes -Partner 10.35.47.12

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed; Data=}
Return Code..: 200
Response.....: Command successfully executed

                            

						

                        
Top of page
				

				

					

						
 Set-LmCloudHAMode 

						
Set the Cloud High Availability (HA) mode.

						
Set the HA mode to active, standby, or single for the specified LoadMaster.

					

                        

                        
 Syntax 

                        

						

                            


Set-LmCloudHAMode -HAMode <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Set-LmCloudHAMode -HAMode <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] 
[-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-HAMode
                                        
										Specify the HA mode.
Valid values for this parameter are:
 - SingleMode
 - HA First
 - HA Second
If only using a single LoadMaster, set this to SingleMode. In HA mode, one machine must be specified as the first and the 
other machine must be specified as the second.		
										true
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Set-LmCloudHAMode -HAMode master

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed; Data=}
Return Code..: 200
Response.....: Command successfully executed

                            

						

                        
Top of page
				

				

					

						
 Set-LmDateTimeConfiguration 

						
Allows you to set the values of the Date and Time options.

						
Allows you to set the values of the Date and Time options.

					

                        

                        
 Syntax 

                        

						

                            


Set-LmDateTimeConfiguration [-NTPHost <String>] [-TimeZone <String>] [-NTPKeyId <Int32>] [-NTPKeySecret <String>] 
[-NTPKeyType <String>] [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Set-LmDateTimeConfiguration [-NTPHost <String>] [-TimeZone <String>] [-NTPKeyId <Int32>] [-NTPKeySecret <String>] 
[-NTPKeyType <String>] [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN 
<String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-NTPHost
                                        
										Specifies the time synchronization server. Multiple hosts can be specified using a space-separated list.
										false
										false
										
									

									

										-TimeZone
                                        
										Specifies the time zone of the LoadMaster. Valid values are timezones, for example:
Etc/UTC
GMT
CET
US/Central
US/Eastern
Europe/Rome		
										false
										false
										
									

									

										-NTPKeyId
                                        
										The NTP key ID. Valid values range from 1 to 99.
										false
										false
										
									

									

										-NTPKeySecret
                                        
										The NTP shared secret string. The NTP secret can be a maximum of 40 characters long. If the secret is more than 20 
characters long, it is treated as a hex string. Setting this value to an empty string will disable the NTPv4 feature.		
										false
										false
										
									

									

										-NTPKeyType
                                        
										Specify the NTP Key Type. The valid values are SHA-1 and MD5. Note that the values are case sensitive and must be in 
uppercase.		
										false
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
						

                            

                                
 Note 

                            

							
This is a legacy command and cannot be used to set all of the available parameters. Please refer to the Get-Help of the 
    Set-Parameter command to view a full list of parameters that can be configured.

						

                        

                            
 Examples 

                        

						

                            

							    Example

Set-LmDateTimeConfiguration -NTPHost 128.192.150.11 -TimeZone WET

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed; Data=}
Return Code..: 200
Response.....: Command successfully executed
Data field...: @{DateTimeConfiguration=}
Param........: @{NTPHost=128.192.150.11; Time=Thu, 20 Apr 17 12:21:06 WEST; BootTime=Thu, 20 Apr 17 12:02:28 WEST; 
ActiveTime=Thu, 20 Apr 17 12:02:28 WE
ST; TimeZone=WET; NTPKeyId=0}

                            

						

                        
Top of page
				

				

					

						
 Set-LmDebugConfiguration 

						
Allows to set some of the values of options contained in the in the Debug Option screen of the WUI.

						
Allows to set some of the values of options contained in the in the Debug Option screen of the WUI.

					

                        

                        
 Syntax 

                        

						

                            


Set-LmDebugConfiguration [-irqbalance <Boolean>] [-linearesplogs <Boolean>] [-netconsole <String>] [-netconsoleinterface 
<Int16>] [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction <ActionPreference>] 
[-InformationVariable <String>] [<CommonParameters>]

Set-LmDebugConfiguration [-irqbalance <Boolean>] [-linearesplogs <Boolean>] [-netconsole <String>] [-netconsoleinterface 
<Int16>] [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN <String>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-irqbalance
                                        
										The purpose of IRQBalance is distribute hardware interrupts across processors on a multiprocessor system. This should only 
be enabled after consultation with Kemp technical support.		
										false
										false
										
									

									

										-linearesplogs
                                        
										By default, the LoadMaster deletes older log files. If this parameter is enabled, older log files will no longer be 
deleted. If the filesystem fills up, further access via the LoadMaster is blocked.		
										false
										false
										
									

									

										-netconsole
                                        
										Netconsole is a kernel module which logs kernel printk messages over UDP allowing debugging of problems where disk logging 
fails. If directed by a Kemp support engineer, the syslog daemon on a specific host will receive all critical kernel 
messages. This can help in understanding why a LoadMaster is rebooting. Netconsole is mainly used for capturing kernel 
panic output.
To unset this, set the value to an empty string.		
										false
										false
										
									

									

										-netconsoleinterface
                                        
										The interface which hosts the Netconsole.
										false
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Set-LmDebugConfiguration -irqbalance 1

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.
Data field...: @{Parameters=}
irqbalance : yes

                            

						

                        
Top of page
				

				

					

						
 Set-LmHAConfiguration 

						
Allows you to set the values of High Availability (HA) options.

						
Configure the HA options.

					

                        

                        
 Syntax 

                        

						

                            


Set-LmHAConfiguration [-hatimeout <Int16>] [-hawait <Int16>] [-havhid <Int16>] [-haprefered <String>] [-haif <Int16>] 
[-hal4update <Boolean>] [-hal7update <Boolean>] [-MCast <Int16>] [-Vmac <Boolean>] [-LoadBalancer <String>] [-LBPort 
<Int32>] [-Credential <Object>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Set-LmHAConfiguration [-hatimeout <Int16>] [-hawait <Int16>] [-havhid <Int16>] [-haprefered <String>] [-haif <Int16>] 
[-hal4update <Boolean>] [-hal7update <Boolean>] [-MCast <Int16>] [-Vmac <Boolean>] [-LoadBalancer <String>] [-LBPort 
<Int32>] [-CertificateStoreLocation <String>] [-SubjectCN <String>] [-InformationAction <ActionPreference>] 
[-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-hatimeout
                                        
										The time the master must be unavailable before a switchover occurs. The valid predetermined time intervals are listed below 
(in seconds):
3
6
9
12
15		
										false
										false
										
									

									

										-hawait
                                        
										This is how long (in seconds) after the initial boot, before the LoadMaster becomes active. If the partner machine is 
running this value is ignored. This value can be changed to mitigate the time taken for some intelligent switches to detect 
that the LoadMaster has started and to bring up the link.		
										false
										false
										
									

									

										-havhid
                                        
										When using multiple HA LoadMasters on the same network, this value identifies each cluster so that there are no potential 
unwanted interactions.		
										false
										false
										
									

									

										-haprefered
                                        
										By default, neither partner in a HA cluster has priority. When a machine restarts after a switchover that machine becomes a 
slave. Specifying a preferred host means that when this machine restarts it will always become the master and the partner 
will revert to slave mode.		
										false
										false
										
									

									

										-haif
                                        
										The network interface used when synchronising the configuration between the members of the HA cluster.
										false
										false
										
									

									

										-hal4update
                                        
										When using L4 services, enabling updates allows L4 connection maintenance across a HA switchover. This option is ignored 
for L7 services. Valid values:
0 - Disabled
1 - Enabled		
										false
										false
										
									

									

										-hal7update
                                        
										When using L7 services, enabling this option allows sharing of persistency information between HA partners. If a HA 
switchover occurs, the persistency information will then not be lost. Enabling this option can have a significant 
performance impact. Valid values:
0 - Disabled
1 - Enabled		
										false
										false
										
									

									

										-MCast
                                        
										The network interface used for multicast traffic which is used to synchronize Layer 4 and Layer 7 traffic when Inter HA 
Updates are enabled.		
										false
										false
										
									

									

										-Vmac
                                        
										This option creates a shared MAC address for both units. When failover occurs, the LoadMaster handles the MAC address 
handover too. This allows the switches to keep the MAC address and not worry about ARP caches or stale records.		
										false
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
						

                            

                                
 Note 

                            

							
To get the HA status, run the following command: Get-LmParameter -Param HAStatus
    To enable HA checking on an interface, run the following command: Set-NetworkInterface -HACheck <InterfaceID>

						

                        

                            
 Examples 

                        

						

                            

							    Example

Set-LMHAConfiguration -HATimeout 3

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.
hatimeout : 3

                            

						

                        
Top of page
				

				

					

						
 Set-LmHAMode 

						
Set the High Availability (HA) mode.

						
Set the HA mode.

					

                        

                        
 Syntax 

                        

						

                            


Set-LmHAMode -HaMode <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Set-LmHAMode -HaMode <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN 
<String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-HaMode
                                        
										The HA mode can be one of the following options:
SingleMode - Non-HA mode
First - HA 1 mode
Second - HA 2 mode		
										true
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Set-LmHAMode -HaMode SingleMode

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.

                            

						

                        
Top of page
				

				

					

						
 Set-LmParameter 

						
A large number of LoadMaster parameters can be configured using the Set-LmParameter command.

						
Below is a list of the parameters that can be configured using the Set-LmParameter command. The parameters are grouped and 
ordered by WUI section.


-----------------
WUI Section: Home
-----------------


version
Retrieves the LoadMaster firmware version.


serialnumber
The serial number of the LoadMaster.


boottime
The time at which the LoadMaster last booted.


activetime
When using non-HA mode, the activetime is the same as the boottime. When in HA mode, the active time is the time at which 
the LoadMaster last became the master unit. The active time will be zero if the LoadMaster is in slave mode.


---------------------------------------------------------------------
WUI Section: Virtual Services > View/Modify Services > SSL Properties
---------------------------------------------------------------------


securityheaderage
The maximum age for the security header. Valid values for this parameter range from 86400 (1 day) to 31536000 (1 year).


--------------------------------------------------------------------------
WUI Section: Virtual Services > View/Modify Services > Advanced Properties
--------------------------------------------------------------------------


addvia
Specifies which headers should be added to the HTTP stream. The parameter takes the following arguments:
   0 = Legacy Operation
   1 = X-Forwarded-For
   2 = None
   3 = X-Client-Side
   4 = X-Client-Side No Via
   5 = X-Forwarded-For No Via
   6 = Via Only


------------------------------------
WUI Section: Certificates & Security
------------------------------------


localcert
This parameter is only relevant when using HA.


-------------------------------------------------------
WUI Section: Certificates & Security > SSL Certificates
-------------------------------------------------------


admincert
The certificate used, if any, for the administrative interface.


----------------------------------------------------
WUI Section: Certificates & Security > Remote Access
----------------------------------------------------


admingw
When administering the LoadMaster from a non-default interface, this option allows the user to specify a different default 
gateway for administrative traffic only.


sshaccess
Specify over which addresses remote administrative SSH access to the LoadMaster is allowed.


sshport
Specify the port used to access the LoadMaster via the SSH protocol.


wuiaccess
Enables or disables access to the Web User Interface (WUI).


wuiiface
Specifies the interface for the WUI.


wuiport
Specifies the port to access the WUI.


sshiface
Specify the addresses over which remote administrative SSH access to the LoadMaster is allowed.


enableapi
Enables the programmable command API Interface.
Note: If this is disabled, the API will no longer be accessible.


adminclientaccess
Valid values for this parameter are:
0 – Password only access (default)
1 – Password or client certificate
2 – Client certificate required
3 – Client certificate required (verify via OCSP)
This parameter is only relevant if Session Management is enabled. For further information on Session Management and on the 
Admin Client Access option, refer to the User Management, Feature Description on the Kemp documentation page: 
www.kemptechnologies.com/documentation


tethering
Allow the LoadMaster to regularly check the Kemp website for new software versions.
0 - Disabled
1 - Enabled


geoclients
Set the addresses of the GEO LoadMasters which can retrieve service status information from the LoadMaster.


geopartners
Set the IP address of the GEO LoadMaster partner(s). These GEO LoadMasters will keep their DNS configurations in sync.
Note: Before partnering GEO LoadMasters, a backup should be taken of the relevant GEO LoadMaster which has the 
correct/preferred configuration. This backup should then be restored to the other LoadMasters


that will be partnered with the original LoadMaster.


multihomedwui
Allow WUI access from multiple interfaces. Apart from the main administrative interface, each interface can then be enabled 
to allow WUI access.


SSHPreAuth
Set the SSH pre-authentication banner, which is displayed before the login prompt when logging in via SSH. Space characters 
should be escaped by entering %20.
This field accepts up to 5,000 characters. Anything past the 5,000 character limit will not be displayed.


sessioncac
If this parameter is enabled, the LoadMaster will also check for a Common Access Card (CAC) certificate when a user is 
logging on to the WUI.
0 - Disabled
1 - Enabled


--------------------------------------------------------------------------------
WUI Section: Certificates & Security > Remote Access > WUI Authorization Options
--------------------------------------------------------------------------------


sessionauthmode
Specifies the authentication mode for the LoadMaster.
Refer to the following table for values:


|          RADIUS             |     LDAP      |        Local
Value    |    Authent.    Author.  |   Authent.   |  Authent.    Author.
7           |    No          No            |   No            |  No          No
263       |    Yes         No             |   No           |  Yes         Yes
775       |    Yes         Yes             |   No           |  Yes         Yes
23         |   No          No             |   Yes           |  Yes         Yes
22         |    No          No            |   Yes           |  No          Yes
788       |    Yes         Yes            |   Yes           |  No          No
790       |    Yes         Yes            |   Yes           |  No          Yes
791       |    Yes         Yes            |   Yes           |  Yes         Yes
789       |    Yes         Yes            |   Yes           |  Yes         No
773       |    Yes         Yes            |   No           |  Yes         No
262       |    Yes         No            |   No           |  No          Yes
774       |    Yes         Yes            |   No           |  No          Yes
772       |    Yes         Yes            |   No           |  No          No
278       |    Yes         No            |   Yes           |  No          No
279       |    Yes         No            |   Yes           |  Yes         Yes


sessionlocalauth
Enables or disables local authentication.


radiusbackupport
Specifies the TCP port for the backup RADIUS server.


radiusbackupsecret
Specifies the password (secret) to the backup RADIUS server.


radiusbackupserver
Specifies the backup RADIUS server to use for authentication.


radiusport
Specifies the TCP port for communication to the RADIUS server.


radiussecret
Specifies the password (secret) to the RADIUS server.


radiusserver
Specifies the RADIUS server to use for authentication.


radiusrevalidateinterval
Specifies when to revalidate the authentication to the RADIUS server.


radiussendnasid
If this parameter is disabled (default), a Network Access Server (NAS) identifier is not sent to the RADIUS server. If it 
is enabled, a NAS identifier string is sent to the RADIUS server. By default, this is the hostname. Alternatively, if you 
specify a value in the radiusnasid parameter, this value is used as the NAS identifier. If the NAS identifier cannot be 
added, the RADIUS access request is still processed.


radiusnasid
If the radiussendnasid parameter is enabled, the radiusnasid parameter is relevant. When specified, this value is used as 
the NASidentifier. Otherwise, the hostname is used as the NAS identifier. If the NAS identifier cannot be added, the RADIUS 
access request is still processed.


ldapserver
Specifies the LDAP server to use for authentication.


ldapbackupserver
Specifies the backup LDAP server for authentication.


ldapsecurity
Specifies the security mode for LDAP authentication.


ldaprevalidateinterval
Specifies how often to revalidate the authentication to the LDAP server.


wuidomain
Specify the domain to use if no domain is provided in the username when group WUI authentication is in use. It is always 
used as the domain for group search if the Windows logon is used in the format prefix\username.


-------------------------------------------------------
WUI Section: Certificates & Security > Admin WUI Access
-------------------------------------------------------


sessionidletime
Specifies the number of seconds that the WUI can be idle before logging the user out. This can be set from 60 to 86400 
seconds.


sessionmaxfailattempts
Number of failed attempts before locking the user account. This can be set from 1 to 999.


sessioncontrol
Enables or disables session control.


sessionbasicauth
If the SessionControl and SessionBasicAuth parameters are both enabled, there are two levels of authentication enforced in 
order to access the LoadMaster WUI. The initial level is Basic Authentication where


users log in using the bal or user logins, which are default usernames defined by the system.


sessionconcurrent
Limit the maximum number of concurrent connections a single user can have. 
Range: 0 to 9. A value of 0, means logins are unlimited.


geosshport
The port over which GEO LoadMasters will communicate with on another.


WUIPreAuth
Set the pre-authentication click through banner which will be displayed before the LoadMaster login page. This parameter 
can contain plain text or HTML code. The field cannot contain JavaScript. This field


accepts up to 5,000 characters. Anything past the 5,000 character limit will not be displayed.


WUITLSProtocols
Specify whether or not it is possible to connect to the LoadMaster WUI using the following protocols; SSLv3, TLS1.0, TLS1.1 
or TLS1.2. The protocols can be enabled and disabled using a bitmask value in the range 0 to 14. Refer to the table below 
to find out what number corresponds to which settings.


Number |   SSLv3     | TLS1.0   | TLS1.1    | TLS1.2
0      |   Enabled   | Enabled  | Enabled   | Enabled
1      |   Disabled  | Enabled  | Enabled   | Enabled
2      |   Enabled   | Disabled | Enabled   | Enabled
3      |   Disabled  | Disabled | Enabled   | Enabled
4      |   Enabled   | Enabled  | Disabled  | Enabled
5      |   Disabled  | Enabled  | Disabled  | Enabled
6      |   Enabled   | Disabled | Disabled  | Enabled
7      |   Disabled  | Disabled | Disabled  | Enabled
8      |   Enabled   | Enabled  | Enabled   | Disabled
9      |   Disabled  | Enabled  | Enabled   | Disabled
10     |   Enabled   | Disabled | Enabled   | Disabled
11     |   Disabled  | Disabled | Enabled   | Disabled
12     |   Enabled   | Enabled  | Disabled  | Disabled
13     |   Disabled  | Enabled  | Disabled  | Disabled
14     |   Enabled   | Disabled | Disabled  | Disabled


WUICipherset
Specify the cipher set to use for the LoadMaster WUI. System-defined cipher sets and custom cipher sets can be assigned 
using this parameter. The valid values are below:
 - Default
 - Default_NoRc4
 - BestPractices
 - Intermediate_compatibility
 - Backward_compatibility
 - WUI
 - FIPS
 - Legacy
 - Null_Ciphers
 - <NameOfCustomCipherSet>
The Null_Ciphers set is only for Direct Access and IP-HTTPS VIPs for Windows 8/10 clients.
The Null_Ciphers set does not work on Cavium3 machines.


---------------------------------------------------------
WUI Section: Certificates & Security > OCSP Configuration
---------------------------------------------------------


OCSPPort
The port of the OCSP server.


OCSPUseSSL
Specify whether or not to use SSL to connect to the OCSP server.


OCSPOnServerFail
Treat an OCSP server connection failure of timeout as if the OCSP server had returned a valid response, i.e. treat the 
client certificate as valid.


OCSPServer
The address of the OCSP server.


OCSPUrl
The URL to access on the OCSP server.


SSLStapling
Enable this parameter to enable the LoadMaster to respond to OCSP stapling requests. If a client connects using SSL and 
asks for an OCSP response, this is returned. Only Virtual Service certificates are validated. The system holds a cache of 
OCSP responses that are sent back to the client. This cache is maintained by the OCSP daemon. When the OCSP daemon sends a 
request to the server, it uses the name specified in the certificate (in the Authority Information Access field). If it 
cannot resolve this name, then it uses the default OCSP server specified in the OCSPServer parameter.


SSHRefreshInterval
Specify how often the LoadMaster should refresh the OCSP stapling information. The OCSP daemon caches the entry for up to 
the amount of time specified here, after which it is refreshed.
Valid values range from 3600 (1 hour (default)) to 86400 seconds (24 hours).


--------------------------------------------------------------
WUI Section: System Configuration > Network Setup > Interfaces
--------------------------------------------------------------


mcast
The network interface used for multicast traffic which is used to synchronize Layer 4 and Layer 7 traffic when Inter HA 
Updates are enabled.


----------------------------------------------------------------------------
WUI Section: System Configuration > Network Setup > Host & DNS Configuration
----------------------------------------------------------------------------


dnssecclient
Enable or disable DNSSEC client capabilities on the LoadMaster. At least one name server must be configured before DNSSEC 
can be enabled. After changing this setting, the LoadMaster must be rebooted for the change to be applied. Once the setting 
is changed, it cannot be changed again until the LoadMaster has been rebooted. If using HA, please set the parameter on 
both devices separately.
   0 = Disabled
   1 = Enabled


DNSNamesEnable
When this option is enabled, the LoadMaster automatically attempts to update any changed DNS names (based on the update 
interval):
- If the address is not found, or if it is the same as before – nothing is done (except a log entry is generated).
- If the address is different, the Real Server entry is updated with the new address, if possible.
- If the new address is invalid for some reason, for example if it is a non-local address and the nonlocalrs option is 
disabled, no changes are made and a log is generated.


dnsupdateinterval
Set the update interval for DNS entries. Valid values range from 1-60 (minutes). The default value is 60.


dnsreloadonerror
If this parameter is enabled, DNS entries are reloaded when health checks have errors and an FQDN is associated with the 
Real Server IPaddress.


namserver
The DNS server the LoadMaster will use for name resolution. Setting this parameter to an empty string will delete the name 
servers. The last remaining name server cannot be deleted if the dnssecclient parameter is enabled. This parameter has been 
deprecated and replaced with the nameserver parameter.


nameserver
The DNS server the LoadMaster will use for name resolution. Setting this parameter to an empty string will delete the name 
servers. The last remaining name server cannot be deleted if the dnssecclient parameter is enabled.


ha1hostname
When using the LoadMaster in HA mode, this is the host name of the first node. If the LoadMaster is not in HA mode, then 
this will return an error.


ha2hostname
When using the LoadMaster in HA mode, this is the host name of the second node. If the LoadMaster is not in HA mode, then 
this will return an error.


hostname
The hostname assigned to the LoadMaster.


searchlist
The domain suffix search list when performing DNS resolution.


-------------------------------------------------------------------
WUI Section: System Configuration > Network Setup > Default Gateway
-------------------------------------------------------------------


Before setting the default gateway, the network interface addresses must be configured, for example:
Set-NetworkInterface -GWIface 1


Dfltgw
Specify the IPv4 default gateway that is to be used for communicating with the internet.


dfltgwv6
Specify the IPv6 default gateway that is to be used for communicating with the internet.


---------------------------------------------------------------------------
WUI Section: System Configuration > System Administration > User Management
---------------------------------------------------------------------------


extendedperms
The Virtual Service operations permitted vary depending on whether or not the extendedperms parameter is enabled. For 
further information, refer to the UserManagement Feature Description on the Kemp Documentation Page: 
https://kemptechnologies.com/loadmaster-documentation/.


--------------------------------------------------------------------------
WUI Section: System Configuration > System Administration > Update License
--------------------------------------------------------------------------


hideaslloginmsg
If this parameter is enabled, the activation licensing text for Kemp 360 Central is shown on the LoadMaster login screen.
0 - Disabled
1 - Enabled


--------------------------------------------------------------------------
WUI Section: System Configuration > System Administration > Backup/Restore
--------------------------------------------------------------------------


backupday
For scheduled backups, this parameter specifies the "day" number (0-7).


backupenable
Specifies if scheduled backups are enabled.


backuphost
Specifies the host to save the backup file to.


backuphour
For scheduled backups, this parameter specifies the "hour" number (0-23).


backupminute
For scheduled backups, this parameter specifies the "minute" number (0-59).


backupmethod
Specify the file transfer method for automated backups. Valid values are:
Ftp
SCP
sftp


backuppassword
Specifies the password for the user account that has access to save the backup file.


backuppath
Specifies the path on the remote host for saving the backup file.


backupuser
Specifies the user account that has access to save the backup file.


---------------------------------------------------------------------
WUI Section: System Configuration > System Administration > Date/Time
---------------------------------------------------------------------


ntphost
Specifies the time synchronization server. Multiple hosts can be specified using a space-separated list.


ntpkeytype
Specify the NTP Key Type. The valid values are SHA-1 (SHA) and MD5 (M). The values must be specified in uppercase.


ntpkeysecret
The NTP shared secret string. The NTP secret can be a maximum of 40 characters long. If the secret is more than 20 
characters long, it is treated as a hex string. Setting this value to an empty string will disable the NTPv4 feature.


ntpkeyid
The NTP key ID. Valid values range from 1 to 99.


timezone
Specifies the time zone of the LoadMaster.


time
Sets the time of the LoadMaster.


-------------------------------------------------------------------
WUI Section: System Configuration > Logging Options > Debug Options
-------------------------------------------------------------------


irqbalance
The purpose of IRQBalance is distribute hardware interrupts across processors on a multiprocessor system. This should only 
be enabled after consultation with Kemp Technical Support.


backuptop
By default, the LoadMaster does not include top command output in a backup. To include it, enable the backuptop parameter. 
When included in backups, top is run using the default parameters (regardless of what is configured in the WUI) and is 
sorted by memory usage.


backupnetstat
By default, the LoadMaster includes a Netstat output in backups taken. When this is included, backups take longer to 
complete. You can stop the Netstat output from being included by disabling this parameter.


linearesplogs
By default, the LoadMaster deletes older log files. If this parameter is enabled, older log files will no longer be 
deleted. If the filesystem fills up, further access via the LoadMaster is blocked.


netconsole
Netconsole is a kernel module which logs kernel printk messages over UDP allowing debugging of problems where disk logging 
fails. If directed by a Kemp support engineer, the syslog daemon on a specific host


will receive all critical kernel messages. This can help in understanding why a LoadMaster is rebooting.


netconsoleinterface
The interface which hosts the Netconsole.


--------------------------------------------------------------------
WUI Section: System Configuration > Logging Options > Syslog Options
--------------------------------------------------------------------


syslogemergency
Use this option to set the host(s) which will receive Emergency events only. Entries must be comma-separated. Up to 10 
entries are supported in total for all levels.


syslogcritical
Use this option to set the host(s) which will receive Emergency and Critical events. Entries must be comma-separated. Up to 
10 entries are supported in total for all levels.


syslogerror
Use this option to set the host(s) which will receive Emergency, Critical and Error events. Entries must be 
comma-separated. Up to 10 entries are supported in total for all levels.


sysloginfo
Use this option to set the host(s) which will receive Emergency, Critical, Error and Warning events. Entries must be 
comma-separated. Up to 10 entries are supported in total for all levels.


syslognotice
Use this option to set the host(s) which will receive Emergency, Critical, Error, Warning and Notice events. Entries must 
be comma-separated. Up to 10 entries are supported in total for all levels.


syslogwarn
Use this option to set the host(s) which will receive All events. Entries must be comma-separated. Up to 10 entries are 
supported in total for all levels.


syslognone
Use the Set-LmParameter command with this option to delete a host, or hosts, from any syslog level. Because you can only 
assign a specific host to one level, you do not need to specify the syslog level to remove the host from. Entries must be 
comma-separated. Up to 10 entries can be deleted at once.
The Get-LmParameter command does not retrieve anything for this parameter.


syslogport
Specify the port that syslog messages are sent to on the receiving hosts.


------------------------------------------------------------------
WUI Section: System Configuration > Logging Options > SNMP Options
------------------------------------------------------------------


snmpenable
Enable or disable SNMP.


snmpV3enable
Enable SNMP V3.
   0 = Disabled
   1 = Enabled


snmpv3user
Specify the username.


snmpv3userpasswd
Specify the user password.


snmpAuthProt
Specify the relevant authentication protocol:
   - MD5
   - SHA
SHA is a more secure protocol.


snmpPrivProt
Specify the relevant privacy protocol:
   - DES
   - AES
AES is a more secure protocol.


snmpcontact
Specify the contact address that is sent in SNMP responses.


snmpcommunity
Specify the SNMP community string.


snmplocation
Specify the location that is sent in SNMP responses.


snmpHaTrap
Send SNMP traps from the shared IP address. This option is only available when the LoadMaster is in HA mode.


snmpv1sink
Specify the sink address for SNMP type 1 traps.


snmpv2sink
Specify the sink address for SNMP type 2 traps.


snmpclient
Specify the list of machines that can access the SNMP subsystem. If no clients are specified, then anyone can access SNMP.


snmptrapenable
Enable the generation of SNMP events whenever a significant event occurs.


-------------------------------------------------------------------
WUI Section: System Configuration > Logging Options > Email Options
-------------------------------------------------------------------


emailuser
The user account with access to send mail messages.


emaildomain
The domain, if required, for the user account authentication.


emailpassword
The email user's password.


emailserver
The host name or address of the SMTP server to send mail messages through.


emailsslmode
Specify the type of security protocol that should be used on the connection:
   0 = None
   1 = STARTTLS, if available
   2 = STARTTLS
   3 = SSL/TLS


emailport
The TCP port on which your mail server accepts connections (usually 25).


emailcritical
The email address to receive critical messages.


emailemergency
The email address to receive emergency messages.


emailerror
The email address to receive error messages.


emailinfo
The email address to receive informational messages.


emailnotice
The email address to receive notices.


emailwarn
The email address to receive warnings.


emailenable
Enables or disables the email logging options.


-------------------------------------------------------------------
WUI Section: System Configuration > Logging Options > SDN Log Files
-------------------------------------------------------------------


sdnstatsmode
There are two modes that can be used to gather the SDN statistics.
The modes are described below:
• Mode 1: When set to mode 1, the statistics are taken from the switch port that is connected to the server and the 
statistics are relayed back to the LoadMaster.
• Mode 2: When set to mode 2, the information is taken from all of the switch ports along the path.


------------------------------------------------------------------------
WUI Section: System Configuration > Miscellaneous Options > WUI Settings
------------------------------------------------------------------------


hoverhelp
Enables or disables hover help in the WUI.


motd
Sets the Message Of The Day (MOTD) for the web user interface. Either plain text or a text file can be used.
The maximum number of characters is 5,000.
An error will be displayed if the MOTD is greater than 5,000 characters.


wuidisplaylines
Specifies the number of display lines in the WUI. This can be set from 10 to 100.


----------------------------------------------------------------------------
WUI Section: System Configuration > Miscellaneous Options > L7 Configuration
----------------------------------------------------------------------------


transparent
When using Layer 7, when this is enabled the connection arriving at the Real Server appears to come directly from the 
client. Alternatively, the connection can be non-transparent which means that the


connections at the Real Server appear to come from the LoadMaster.


alwayspersist
This parameter also accepts no and yes as valid values. No and Yes correspond to 0 and 1 respectively.


expect100
By default, the L7 module only waits for 100-Continue replies if it sees an Expect-100 header, use RFC-2616 Compliant. If 
the system will always wait for 100 Continue messages, use Require 100-Continue. If


the client will always send the POST data even if a 100 Continue message is not sent, use RFC-7231 Compliant instead.


localbind
In very high load situations, local port exhaustion can occur. Enabling this option allows the setting of alternate source 
addresses. This can be used to expand the number of available local ports.


addcookieport
When using the LoadMaster behind a NATing gateway, all client addresses are the same. To create individual cookies the 
remote port can also be added to the cookie. Enabling this option when not needed wastes


resources.


addforwardheader
This option, only available when L7 Transparency is disabled, allows the addition of either X-ClientSide or X-Forwarded For 
to the HTTP header.


authtimeout
The duration (in seconds) that a connection remains open for while authentication is ongoing. This value can be between 30 
and 300.


clienttokentimeout
The duration (in seconds) to wait for the client token while the process of authentication is ongoing (used for RSA SecurID 
and RADIUS authentication). The default value for this parameter is 120.


finalpersist
When a Real Server is disabled, the sessions persisting on that Real Server continue to be served until the Drain Time has 
expired or until no more sessions are being handled by the Real Server. No new sessions will be handled by the Real Server. 
Valid values include 0, and 60 to 86400.


rfcconform
By default, the LoadMaster conforms to the RFC when parsing HTTP headers. Disabling this will allow interworking with some 
broken browsers.


dropatdrainend
If enabled, all open connections to disabled Real Servers will be dropped at the end of the Real Servers Drain Stop Time or 
immediately if there are no Persist entries associated with the Real Server.


droponfail
By default, existing connections are not closed if a Real Server fails. Enabling this feature causes all connections to be 
immediately dropped on Real Server failure.


closeonerror
When enabled, the LoadMaster will always close the client connection when it sends back an error response. For Example, 
this changes the behaviour of the LoadMaster when sending back a 304 File not changed


message after receiving an If-Modified-Since HTTP header.


rsarelocal
When checking to see if a client is on the local subnet, also check to see if the client is actually a Real Server.


slowstart
When using the Least Connection (or Weighted Least Connection) scheduling method, specify the time (in seconds) over which 
the load to a Real Server which has just come online will be throttled.


ShareSubVSPersist
By default, each SubVS has an independent persistence table. Enabling this parameter will allow the SubVS to share this 
information.


logsplitinterval
When using Log Insight Scheduling this is the number of messages which are received on a connection before the stream is 
rescheduled. The default value is 10.


allowemptyposts
By default the LoadMaster blocks POSTs that do not contain a Content-Length or Transfer-Encoding header to indicate the 
length of the requests payload. When this parameter is set to true, such requests are assumed to have no payload data and 
are therefore not rejected.


forcefullrsmatch
By default, when the LoadMaster is trying to locate a Real Server for use with content switching, it tries to use the same 
Real Server as currently selected, even if the port is not the same. If this parameter is enabled - the port is also 
compared.


AllowEmptyHttpHeaders
By default, if the LoadMaster is processing HTTP headers, it will ignore HTTP headers that have empty content. This can 
break some SOAP Services even though it is against the HTTP RFCs. Enabling this option will allow these empty headers 
through.


loguseragent
When enabled, the User Agent header field is added to the User Logs.
0 - Disabled
1 - Enabled


---------------------------------------------------------------------------
WUI Section: System Configuration > Miscellaneous Options > Network Options
---------------------------------------------------------------------------


snat
Enabling this options allows the LoadMaster to NAT connections from the Real Servers to the internet.


routefilter
When enabled, this option only accepts IP frames from a host over the interface where the routing algorithm would route 
frames to the host. This is known as strict source route validation.


subnetoriginating
When transparency is disabled for a Virtual Service, the source IP address of connections to Real Servers is the Virtual 
Service. When enabled, the source IP address is the local address of the LoadMaster.


If the Real Server is on a subnet, the subnet address of the LoadMaster will be used.


nonlocalrs
Enable this option to allow assigning non-local Real Servers to Virtual Services.


multigw
Use this option to enable the ability to move the default gateway to a different interface.
Note: Alternate default gateway support is not permitted in a cloud environment.


conntimeout
Specify the timeout value for the check request.
Range: 4-60


tcptimestamp
The LoadMaster can include a timestamp in the SYN when connecting to Real Servers. Only enable this option when requested 
to from Kemp Support.


resetclose
When enabled, the LoadMaster will close its connection to the Real Servers by using TCP RESET instead of the normal close 
handshake.


keepalive
By default, the system uses TCP keepalives to check for failed clients. Enabling this option improves the reliability of 
older TCP connections (SSH sessions). Not normally required for normal HTTP/HTTPS


services.


allowupload
The LoadMaster has been optimized with HTTP workloads in mind. Enabling this option allows non HTTP uploads to work 
correctly.


subnetorigin
When transparency is disabled for a Virtual Service, the source IP address of connections to Real Servers is the Virtual 
Service. When enabled, the source IP address is the local address of the LoadMaster.


If the Real Server is on a subnet, the subnet address of the LoadMaster will be used.


onlydefaultroutes
Enable this option to force traffic from Virtual Services, which have default route entries set, to be routed to the 
interface where the Virtual Service’s default route is located.


http_proxy
This option allows clients to specify the HTTP(S) proxy server and port the LoadMaster will use to access the internet.


dhkeysize
Select the strength of the key used in the Diffe-Hellman key exchanges. If this value is changed, a reboot is required in 
order to use the new value. The default value is 2048 Bits.


sslrenegotiate
By default, the LoadMaster allows a client to automatically renegotiate during an SSL transaction. Disabling this parameter 
causes SSL connections to terminate if a renegotiation is requested by the client.


sslforceserververify
By default, when re-encrypting traffic the LoadMaster does not check the certificate provided by the Real Server. Enabling 
this option forces the LoadMaster to verify that the certificate on the Real Server is valid, that is, the certificate 
authority and expiration are OK. This includes all intermediate certificates.


tcpnorecycle
Enable this option to revert to the legacy mode of reusing TCP timewait connections.
Note: Only enable this after consulting with Kemp Support.


-----------------------------------------------------------------------------
WUI Section: System Configuration > Miscellaneous Options > AFE Configuration
-----------------------------------------------------------------------------


paranoia
Sets the sensitivity of IDS detection.


cachesize
Specifies the cache size.


hostcache
Enable or disable using the host cache.


limitinput
Limit the number of connections.


L7LimitInput
This setting limits the default maximum number of connection attempts (per second) from a specific host.


-------------------------------------------------------------------------
WUI Section: System Configuration > Miscellaneous Options > HA Parameters
-------------------------------------------------------------------------


hastatus
The status of a HA or cluster unit. This is a read only parameter and cannot be set. Possible values are:
Normal HA:
Active, Standby, Passive (all as expected).
Cloud HA:
Active, Standby, Passive (if status not yet set).
Cluster: 
Active (if master), Standby (if slave), Passive (if disabled).


hatimeout
The time the master must be unavailable before a switchover occurs. Allowed Values: 1-5, each option being a predetermined 
time interval:
    1 = 3 seconds
    2 = 6 seconds
    3 = 9 seconds
    4 = 12 seconds
    5 = 15 seconds


hawait
This is how long (in seconds) after the initial boot, before the LoadMaster becomes active. If the partner machine is 
running this value is ignored. This value can be changed to mitigate the time taken for  some intelligent switches to 
detect that the LoadMaster has started and to bring up the link.


haprefered
By default, neither partner in a HA cluster has priority. When a machine restarts after a switchover that machine becomes a 
slave. Specifying a preferred host means that when this machine restarts it will always become the master and the partner 
will revert to slave mode.


hamode
Specify the HA mode. If only using a single LoadMaster, use Non-HA Mode. In HA mode, one LoadMaster must be specified as 
the first and another as second. HA will not work if both LoadMasters are specified


the same.
   0 = Turn off HA mode
   1 = HA 1 mode
   2 = HA 2 mode


haif
The network interface used when synchronising the configuration between the members of the HA cluster.


havhid
When using multiple HA LoadMasters on the same network, this value identifies each cluster so that there are no potential 
unwanted interactions.


hastyle
By default, the system uses a version of VRRP (carp) to check the status of the partner. The system can also support the 
legacy Heartbeat program. This option only takes effect when both machines are rebooted.
0 - legacy heartbeat
1 - carp


hainitial
Perform extra network checks at boot time. This may cause instability and should not be used.


tcpfailover
When using L4 services, enabling updates allows L4 connection maintenance across a HA switchover. This option is ignored 
for L7 services.
This parameter is now deprecated and has been replaced with the HAL4update parameter.


cookieupdate
When using L7 services, enabling this option allows sharing of persistency information between HA partners. If a HA 
switchover occurs, the persistency information will then not be lost. Enabling this option


can have a significant performance impact.
This parameter is now deprecated and has been replaced with the HAL7Update parameter.


hal4update
When using L4 services, enabling updates allows L4 connection maintenance across a HA switchover. This option is ignored 
for L7 services.


hal7update
When using L7 services, enabling this option allows sharing of persistency information between HA partners. If a HA 
switchover occurs, the persistency information will then not be lost. Enabling this option  can have a significant 
performance impact.


vmac
This option creates a shared MAC address for both units. When failover occurs, the LoadMaster handles the MAC address 
handover too. This allows the switches to keep the MAC address and not worry about ARP caches or stale records.

					

                        

                        
 Syntax 

                        

						

                            


Set-LmParameter -Param <String> -Value <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Set-LmParameter -Param <String> -Value <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation 
<String>] [-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-Param
                                        
										The parameter to configure.
										true
										false
										
									

									

										-Value
                                        
										The value to set the parameter to.
										true
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Set-LmParameter -Param SSLRefreshInterval -Value 4000

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.

                            

						

                        
Top of page
				

				

					

						
 Set-LmVpnAddrs 

						
Allows you to set the Virtual Private Network (VPN) addresses at the same time.

						
Use this command to set the VPN addresses, such as the local IP address, local subnet(s), remote IP address and remote 
subnet(s).

					

                        

                        
 Syntax 

                        

						

                            


Set-LmVpnAddrs -Name <String> -LocalIp <String> -LocalSubnets <String> -RemoteIp <String> -RemoteSubnets <String> 
[-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction <ActionPreference>] 
[-InformationVariable <String>] [<CommonParameters>]

Set-LmVpnAddrs -Name <String> -LocalIp <String> -LocalSubnets <String> -RemoteIp <String> -RemoteSubnets <String> 
[-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN <String>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-Name
                                        
										The name of the VPN.
										true
										false
										
									

									

										-LocalIp
                                        
										In non-HA mode, the default is the LoadMaster IP address, i.e. the IP address of the default gateway interface.
In HA-mode, the default is the shared IP address.		
										true
										false
										
									

									

										-LocalSubnets
                                        
										When the LocalIp is set, the LocalSubnet is automatically populated. Multiple local subnets can be specified using a 
comma-separated list. Up to 10 IP addresses can be specified.		
										true
										false
										
									

									

										-RemoteIp
                                        
										Set the IP address for the remote side of the connection.
										true
										false
										
									

									

										-RemoteSubnets
                                        
										Set the subnet for the remote side of the connection. Multiple remote subnets can be specified using a comma-separated 
list. Up to 10 IP addresses can be specified.		
										true
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Set-LmVpnAddrs -LocalIp 10.12.12.15 -LocalSubnets 10.12.12.0 -Name ExampleVpnAddress -RemoteIp 172.22.55.52 -RemoteSubnets 172.22.55.0

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.

                            

						

                        
Top of page
				

				

					

						
 Set-LmVpnLocalIp 

						
Allows you to set the local IP address of a Virtual Private Network (VPN).

						
Use this command to configure the local IP address of the specified VPN.

					

                        

                        
 Syntax 

                        

						

                            


Set-LmVpnLocalIp -Name <String> -LocalIp <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Set-LmVpnLocalIp -Name <String> -LocalIp <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation 
<String>] [-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-Name
                                        
										The name of the VPN.
										true
										false
										
									

									

										-LocalIp
                                        
										In non-HA mode, the default is the LoadMaster IP address, i.e. the IP address of the default gateway interface.
In HA-mode, the default is the shared IP address.		
										true
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Set-LmVpnLocalIp -Name ExampleVPN -LocalIp 10.154.11.123

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.

                            

						

                        
Top of page
				

				

					

						
 Set-LmVpnLocalSubnet 

						
Allows you to set the Local Subnet Address(es).

						
Use this command to configure the Local Subnet Address(es) of the Virtual Private Network (VPN).

					

                        

                        
 Syntax 

                        

						

                            


Set-LmVpnLocalSubnet -Name <String> -LocalSubnets <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential 
<Object>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Set-LmVpnLocalSubnet -Name <String> -LocalSubnets <String> [-LoadBalancer <String>] [-LBPort <Int32>] 
[-CertificateStoreLocation <String>] [-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable 
<String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-Name
                                        
										The name of the VPN.
										true
										false
										
									

									

										-LocalSubnets
                                        
										When the LocalIp is set, the LocalSubnet is automatically populated. Multiple local subnets can be specified using a 
comma-separated list. Up to 10 IP addresses can be specified.		
										true
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Set-LmVpnLocalSubnet -LocalSubnets 10.11.11.0 -Name ExampleVpnLocalSubnet

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.

                            

						

                        
Top of page
				

				

					

						
 Set-LmVpnPfsDisable 

						
Disable the Perfect Forward Secrecy (PFS) option.

						
Allows you to disable the PFS option for a particular VPN connection.

					

                        

                        
 Syntax 

                        

						

                            


Set-LmVpnPfsDisable -Name <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Set-LmVpnPfsDisable -Name <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] 
[-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-Name
                                        
										The name of the VPN connection.
										true
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Set-LmVpnPfsDisable -Name ExampleVpn

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.

                            

						

                        
Top of page
				

				

					

						
 Set-LmVpnPfsEnable 

						
Enable the Perfect Forward Secrecy (PFS) option.

						
Allows you to enable the PFS option for a particular VPN connection.

					

                        

                        
 Syntax 

                        

						

                            


Set-LmVpnPfsEnable -Name <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Set-LmVpnPfsEnable -Name <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] 
[-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-Name
                                        
										The name of the VPN connection.
										true
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Set-LmVpnPfsEnable -Name ExampleVpn

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.

                            

						

                        
Top of page
				

				

					

						
 Set-LmVpnRemoteIp 

						
Allows you to set the Remote IP Address of the specified Virtual Private Network (VPN).

						
Set the IP address for the remote side of the connection.

					

                        

                        
 Syntax 

                        

						

                            


Set-LmVpnRemoteIp -Name <String> -RemoteIp <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Set-LmVpnRemoteIp -Name <String> -RemoteIp <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation 
<String>] [-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-Name
                                        
										The name of the VPN.
										true
										false
										
									

									

										-RemoteIp
                                        
										Set the IP address for the remote side of the connection.
										true
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Set-LmVpnRemoteIp -Name ExampleVpnRemoteIp -RemoteIp 172.22.55.2

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.

                            

						

                        
Top of page
				

				

					

						
 Set-LmVpnRemoteSubnet 

						
Allows you to set the Remote Subnet Address(es) of the specified Virtual Private Network (VPN).

						
Use this command to configure the Remote Subnet Address(es) of the specified VPN.

					

                        

                        
 Syntax 

                        

						

                            


Set-LmVpnRemoteSubnet -Name <String> -RemoteSubnets <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential 
<Object>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Set-LmVpnRemoteSubnet -Name <String> -RemoteSubnets <String> [-LoadBalancer <String>] [-LBPort <Int32>] 
[-CertificateStoreLocation <String>] [-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable 
<String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-Name
                                        
										The name of the VPN.
										true
										false
										
									

									

										-RemoteSubnets
                                        
										Set the subnet for the remote side of the connection. Multiple remote subnets can be specified using a comma-separated 
list. Up to 10 IP addresses can be specified.		
										true
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Set-LmVpnRemoteSubnet -Name ExampleVpnRemoteSubnet -RemoteSubnets 10.115.2.0

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.

                            

						

                        
Top of page
				

				

					

						
 Set-LmVpnSecret 

						
Allows you to set the connection secret details of the specified Virtual Private Network (VPN).

						
Configure the connection secret details for the specified VPN.

					

                        

                        
 Syntax 

                        

						

                            


Set-LmVpnSecret -Name <String> -LocalId <String> -RemoteId <String> -Key <String> [-LoadBalancer <String>] [-LBPort 
<Int32>] [-Credential <Object>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Set-LmVpnSecret -Name <String> -LocalId <String> -RemoteId <String> -Key <String> [-LoadBalancer <String>] [-LBPort 
<Int32>] [-CertificateStoreLocation <String>] [-SubjectCN <String>] [-InformationAction <ActionPreference>] 
[-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-Name
                                        
										The name of the VPN.
										true
										false
										
									

									

										-LocalId
                                        
										Identification for the local side of the connection.
										true
										false
										
									

									

										-RemoteId
                                        
										Identification for the remote side of the connection. This can be the remoteip.
										true
										false
										
									

									

										-Key
                                        
										The Pre Shared Key (PSK) string. This is the Shared key which is generated and managed on the Azure side. The key length 
should be at least 16 and at most 64 characters.		
										true
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Set-LmVpnSecret -Key ExampleKeyExampleKey -LocalId 10.35.47.24 -Name ExampleVPN -RemoteId 10.23.34.33

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.

                            

						

                        
Top of page
				

				

					

						
 Set-LmWuiSetting 

						
Configure the WUI settings.

						
Use this command to set values for the WUI settings parameters, such as hoverhelp and motd (Message of the Day).

					

                        

                        
 Syntax 

                        

						

                            


Set-LmWuiSetting [-hoverhelp <Boolean>] [-motd <String>] [-wuidisplaylines <Int32>] [-LoadBalancer <String>] [-LBPort 
<Int32>] [-Credential <Object>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Set-LmWuiSetting [-hoverhelp <Boolean>] [-motd <String>] [-wuidisplaylines <Int32>] [-LoadBalancer <String>] [-LBPort 
<Int32>] [-CertificateStoreLocation <String>] [-SubjectCN <String>] [-InformationAction <ActionPreference>] 
[-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-hoverhelp
                                        
										Enable/disable hover help text in the WUI.
0 - Disable
1 - Enable		
										false
										false
										
									

									

										-motd
                                        
										Set the Message of the Day (MOTD), which is displayed on the WUI home page after logging in.
										false
										false
										
									

									

										-wuidisplaylines
                                        
										Set the maximum number of lines to be displayed on a single statistics page.
										false
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Set-LmWuiSetting -hoverhelp 0 -motd "Example Message of the Day"

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.
Data field...: @{Parameters=}
Param........: @{motd=Example Message of the Day}

                            

						

                        
Top of page
				

				

					

						
 Set-LogEmailConfiguration 

						
Allows you to set the values of the email logging options.

						
Configure the various levels of email logging recipients.

					

                        

                        
 Syntax 

                        

						

                            


Set-LogEmailConfiguration [-EmailEnable <Boolean>] [-EmailServer <String>] [-EmailPort <Int32>] [-EmailUser <String>] 
[-EmailPassword <String>] [-EmailDomain <String>] [-EmailSSLMode <Int16>] [-EmailEmergency <String>] [-EmailCritical 
<String>] [-EmailError <String>] [-EmailWarn <String>] [-EmailNotice <String>] [-EmailInfo <String>] [-LoadBalancer 
<String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] 
[<CommonParameters>]

Set-LogEmailConfiguration [-EmailEnable <Boolean>] [-EmailServer <String>] [-EmailPort <Int32>] [-EmailUser <String>] 
[-EmailPassword <String>] [-EmailDomain <String>] [-EmailSSLMode <Int16>] [-EmailEmergency <String>] [-EmailCritical 
<String>] [-EmailError <String>] [-EmailWarn <String>] [-EmailNotice <String>] [-EmailInfo <String>] [-LoadBalancer 
<String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN <String>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-EmailEnable
                                        
										Enables or disables the email logging options.
										false
										false
										
									

									

										-EmailServer
                                        
										The host name or address of the SMTP server to send mail messages through.
										false
										false
										
									

									

										-EmailPort
                                        
										The TCP port on which your mail server accepts connections (usually 25).
										false
										false
										
									

									

										-EmailUser
                                        
										The user account with access to send mail messages.
										false
										false
										
									

									

										-EmailPassword
                                        
										The email user's password.
										false
										false
										
									

									

										-EmailDomain
                                        
										The domain, if required, for the user account authentication.
										false
										false
										
									

									

										-EmailSSLMode
                                        
										Specify the type of security protocol that should be used on the connection:
   0 - None
   1 - STARTTLS, if available
   2 - STARTTLS
   3 - SSL/TLS		
										false
										false
										
									

									

										-EmailEmergency
                                        
										The email address to receive emergency messages.
										false
										false
										
									

									

										-EmailCritical
                                        
										The email address to receive critical messages.
										false
										false
										
									

									

										-EmailError
                                        
										The email address to receive error messages.
										false
										false
										
									

									

										-EmailWarn
                                        
										The email address to receive warnings.
										false
										false
										
									

									

										-EmailNotice
                                        
										The email address to receive notices.
										false
										false
										
									

									

										-EmailInfo
                                        
										The email address to receive informational messages.
										false
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
						

                            

                                
 Note 

                            

							
To unset a parameter, set the parameter to an empty string, for example:
    Set-LogEmailConfiguration -EmailEmergency ""

						

                        

                            
 Examples 

                        

						

                            

							    Example

Set-LogEmailConfiguration -EmailCritical criticaluser@kemptechnologies.com -EmailEmergency emergencycontact@kemptechnologies.com

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed; Data=}
Return Code..: 200
Response.....: Command successfully executed
Data field...: @{EmailConfiguration=}
Param........: @{EmailEnable=yes; EmailServer=10.154.22.132; EmailPort=80; EmailUser=test; EmailPassword=********; 
EmailDomain=ExampleDomain; EmailSSLMo
de=1; EmailEmergency=emergencycontact@kemptechnologies.com; EmailCritical=criticaluser@kemptechnologies.com; EmailError=; 
EmailWarn=; EmailNotice=; Emai
lInfo=}
EmailEnable    : yes
EmailServer    : 10.154.22.132
EmailPort      : 80
EmailUser      : test
EmailPassword  : ********
EmailDomain    : ExampleDomain
EmailSSLMode   : 1
EmailEmergency : emergencycontact@kemptechnologies.com
EmailCritical  : criticaluser@kemptechnologies.com
EmailError     : 
EmailWarn      : 
EmailNotice    : 
EmailInfo      :

                            

						

                        
Top of page
				

				

					

						
 Set-LogSplitInterval 

						
WARNING: This function is deprecated. Use the following command instead:
Set-AdcL7LogInsightSplitConfiguration

						
WARNING: This function is deprecated. Use the following command instead:
Set-AdcL7LogInsightSplitConfiguration

					

                        

                        
 Syntax 

                        

						

                            


Set-LogSplitInterval -logsplitinterval <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Set-LogSplitInterval -logsplitinterval <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation 
<String>] [-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-logsplitinterval
                                        
										
										true
										false
										
									

									

										-LoadBalancer
                                        
										
										false
										false
										
									

									

										-LBPort
                                        
										
										false
										false
										
									

									

										-Credential
                                        
										
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										
										false
										false
										
									

									

										-SubjectCN
                                        
										
										false
										false
										
									

								
							

						
				
				

				

					

						
 Set-LogSyslogConfiguration 

						
Allows you set which hosts the various Syslog messages get sent to.

						
Configure the various levels of syslog level alerts.

					

                        

                        
 Syntax 

                        

						

                            


Set-LogSyslogConfiguration [-SyslogCritical <String>] [-SyslogEmergency <String>] [-SyslogError <String>] [-SyslogInfo 
<String>] [-SyslogNotice <String>] [-SyslogWarn <String>] [-SysLogNone <String>] [-SyslogPort <UInt16>] [-LoadBalancer 
<String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] 
[<CommonParameters>]

Set-LogSyslogConfiguration [-SyslogCritical <String>] [-SyslogEmergency <String>] [-SyslogError <String>] [-SyslogInfo 
<String>] [-SyslogNotice <String>] [-SyslogWarn <String>] [-SysLogNone <String>] [-SyslogPort <UInt16>] [-LoadBalancer 
<String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN <String>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-SyslogCritical
                                        
										Specifies the syslog host for critical notifications.
										false
										false
										
									

									

										-SyslogEmergency
                                        
										Specifies the syslog host for emergency notifications.
										false
										false
										
									

									

										-SyslogError
                                        
										Specifies the syslog host for error notifications.
										false
										false
										
									

									

										-SyslogInfo
                                        
										Specifies the syslog host for information notices.
										false
										false
										
									

									

										-SyslogNotice
                                        
										Specifies the syslog host for general notifications.
										false
										false
										
									

									

										-SyslogWarn
                                        
										Specifies the syslog host for warning notifications.
										false
										false
										
									

									

										-SysLogNone
                                        
										Use this option to delete a host, or hosts, from any syslog level. Because you can only assign a specific host to one 
level, you do not need to specify the syslog level to remove the host from. Entries must be comma-separated. Up to 10 
entries can be deleted at once. The get command does not retrieve anything for this parameter.		
										false
										false
										
									

									

										-SyslogPort
                                        
										Specify a non-standard port for syslog transfer.
										false
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
						

                            

                                
 Note 

                            

							
Up to ten individual IP addresses/hostnames can be specified for each of the Syslog fields. Multiple IP 
    addresses/hostnames must be differentiated using a comma-separated list.
    
    To unset the configuration for a level, run the command with empty parameter values, for example:
    Set-LogSyslogConfiguration -SyslogError ""

						

                        

                            
 Examples 

                        

						

                            

							    Example

Set-LogSyslogConfiguration -SyslogCritical 10.154.11.39 -SyslogEmergency 10.154.11.26

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed; Data=}
Return Code..: 200
Response.....: Command successfully executed
Data field...: @{SyslogSettings=}
Param........: @{SyslogEmergency=10.154.11.26; SyslogCritical=10.154.11.39; SyslogError=; SyslogWarn=; SyslogNotice=; 
SyslogInfo=10.154.153.94; SyslogPo
rt=60}
SyslogEmergency : 10.154.11.26
SyslogCritical  : 10.154.11.39
SyslogError     : 
SyslogWarn      : 
SyslogNotice    : 
SyslogInfo      : 10.154.153.94
SyslogPort      : 60

                            

						

                        
Top of page
				

				

					

						
 Set-NetworkConfiguration 

						
Allows you to set the values of Networking options.

						
Allows you to set the values of Networking options.

					

                        

                        
 Syntax 

                        

						

                            


Set-NetworkConfiguration [-SNAT <Boolean>] [-AllowUpload <Boolean>] [-ConnTimeout <Int64>] [-KeepAlive <Boolean>] [-MultiGW 
<Boolean>] [-NonLocalRS <Boolean>] [-OnlyDefaultRoutes <Boolean>] [-ResetClose <Boolean>] [-SubnetOrigin <Boolean>] 
[-SubnetOriginating <Boolean>] [-TCPTimeStamp <Boolean>] [-RouteFilter <Boolean>] [-DHKeySize <Int32>] [-Http_Proxy 
<String>] [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction <ActionPreference>] 
[-InformationVariable <String>] [<CommonParameters>]

Set-NetworkConfiguration [-SNAT <Boolean>] [-AllowUpload <Boolean>] [-ConnTimeout <Int64>] [-KeepAlive <Boolean>] [-MultiGW 
<Boolean>] [-NonLocalRS <Boolean>] [-OnlyDefaultRoutes <Boolean>] [-ResetClose <Boolean>] [-SubnetOrigin <Boolean>] 
[-SubnetOriginating <Boolean>] [-TCPTimeStamp <Boolean>] [-RouteFilter <Boolean>] [-DHKeySize <Int32>] [-Http_Proxy 
<String>] [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN <String>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-SNAT
                                        
										Enabling this options allows the LoadMaster to NAT connections from the Real Servers to the internet.
										false
										false
										
									

									

										-AllowUpload
                                        
										The LoadMaster has been optimized with HTTP workloads in mind. Enabling this option allows non HTTP uploads to work 
correctly.		
										false
										false
										
									

									

										-ConnTimeout
                                        
										Specify, in seconds, the time a connection can be idle before it is closed. This is independent of Persistency Timeout. 
Setting a value of 0 resets to the default value of 660 seconds.		
										false
										false
										
									

									

										-KeepAlive
                                        
										By default, the system uses TCP keepalives to check for failed clients. Enabling this option improves the reliability of 
older TCP connections (SSH sessions). Not normally required for normal HTTP/HTTPS services.		
										false
										false
										
									

									

										-MultiGW
                                        
										Use this option to enable the ability to move the default gateway to a different interface.
Note: Alternate default gateway support is not permitted in a cloud environment.		
										false
										false
										
									

									

										-NonLocalRS
                                        
										Enable this option to permit non-local Real Servers to be assigned to Virtual Services.
0 - Disabled
1 - Enabled
This option is enabled by default.		
										false
										false
										
									

									

										-OnlyDefaultRoutes
                                        
										Enable this option to force traffic from Virtual Services, which have default route entries set, to be routed to the 
interface where the Virtual Service’s default route is located.		
										false
										false
										
									

									

										-ResetClose
                                        
										When enabled, the LoadMaster will close its connection to the Real Servers by using TCP RESET instead of the normal close 
handshake.		
										false
										false
										
									

									

										-SubnetOrigin
                                        
										When transparency is disabled for a Virtual Service, the source IP address of connections to Real Servers is the Virtual 
Service. When enabled, the source IP address is the local address of the LoadMaster. If the Real Server is on a subnet, the 
subnet address of the LoadMaster will be used.		
										false
										false
										
									

									

										-SubnetOriginating
                                        
										When transparency is disabled for a Virtual Service, the source IP address of connections to Real Servers is the Virtual 
Service. When enabled, the source IP address is the local address of the LoadMaster. If the Real Server is on a subnet, the 
subnet address of the LoadMaster will be used.		
										false
										false
										
									

									

										-TCPTimeStamp
                                        
										The LoadMaster can include a timestamp in the SYN when connecting to Real Servers. Only enable this option when requested 
to from Kemp Support.		
										false
										false
										
									

									

										-RouteFilter
                                        
										When enabled, this option only accepts IP frames from a host over the interface where the routing algorithm would route 
frames to the host. This is known as strict source route validation.		
										false
										false
										
									

									

										-DHKeySize
                                        
										Select the strength of the key used in the Diffe-Hellman key exchanges. If this value is changed, a reboot is required in 
order to use the new value. The default value is 2048 Bits.		
										false
										false
										
									

									

										-Http_Proxy
                                        
										This option allows clients to specify the HTTP(S) proxy server and port the LoadMaster will use to access the internet.
										false
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
						

                            

                                
 Note 

                            

							
This is a legacy command and cannot be used to set all of the available parameters. Please refer to the Get-Help of the 
    Set-Parameter command to view a full list of parameters that can be configured.

						

                        

                            
 Examples 

                        

						

                            

							    Example

Set-NetworkConfiguration -SNAT 1

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.
Data field...: @{Parameters=}
Param........: @{SNAT=yes}
SNAT : yes

                            

						

                        
Top of page
				

				

					

						
 Set-NetworkDNSConfiguration 

						
Allows you to set the values of the DNS Configuration options.

						
Allows you to set the values of the DNS Configuration options.

					

                        

                        
 Syntax 

                        

						

                            


Set-NetworkDNSConfiguration [-Hostname <String>] [-HA1Hostname <String>] [-HA2Hostname <String>] [-NameServer <String>] 
[-Searchlist <String>] [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Set-NetworkDNSConfiguration [-Hostname <String>] [-HA1Hostname <String>] [-HA2Hostname <String>] [-NameServer <String>] 
[-Searchlist <String>] [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN 
<String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-Hostname
                                        
										The hostname assigned to the LoadMaster.
										false
										false
										
									

									

										-HA1Hostname
                                        
										When using the LoadMaster in HA mode, this is the host name of the first node. If the LoadMaster is not in HA mode, then 
this will return an error.		
										false
										false
										
									

									

										-HA2Hostname
                                        
										When using the LoadMaster in HA mode, this is the host name of the second node. If the LoadMaster is not in HA mode, then 
this will return an error.		
										false
										false
										
									

									

										-NameServer
                                        
										The DNS server the LoadMaster will use for name resolution.
										false
										false
										
									

									

										-Searchlist
                                        
										The domain suffix search list when performing DNS resolution.
										false
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
						

                            

                                
 Note 

                            

							
This is a legacy command and cannot be used to set all of the available parameters. Please refer to the Get-Help of the 
    Set-Parameter command to view a full list of parameters that can be configured.

						

                        

                            
 Examples 

                        

						

                            

							    Example

Set-NetworkDNSConfiguration -NameServer 10.154.33.22

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.
Data field...: @{Parameters=}
Param........: @{nameserver=10.154.33.22}
nameserver : 10.154.33.22

                            

						

                        
Top of page
				

				

					

						
 Set-NetworkInterface 

						
Allows you to set the values of the options of the specified interface.

						
Allows you to set the values of the options of the specified interface.

					

                        

                        
 Syntax 

                        

						

                            


Set-NetworkInterface [-InterfaceID <Int16>] [-IPAddress <String>] [-MTU <Int32>] [-HACheck <Boolean>] [-GWIface <Boolean>] 
[-clupdate <Boolean>] [-GeoTraffic <Boolean>] [-BondMode <String>] [-Partner <String>] [-Shared <String>] [-LoadBalancer 
<String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] 
[<CommonParameters>]

Set-NetworkInterface [-InterfaceID <Int16>] [-IPAddress <String>] [-MTU <Int32>] [-HACheck <Boolean>] [-GWIface <Boolean>] 
[-clupdate <Boolean>] [-GeoTraffic <Boolean>] [-BondMode <String>] [-Partner <String>] [-Shared <String>] [-LoadBalancer 
<String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN <String>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-InterfaceID
                                        
										The ID of the network interface.
										false
										false
										
									

									

										-IPAddress
                                        
										The IP Address to be assigned to the specified network interface.
										false
										false
										
									

									

										-MTU
                                        
										The MTU setting for this interface.
										false
										false
										
									

									

										-HACheck
                                        
										This parameter is only relevant in a HA/cluster configuration. Specify whether or not to use this interface for HA/cluster 
checks.
0 – Not used for HA/cluster checks
1 – Used for HA/cluster checks


The default interface used for checking is eth0. When this option is enabled for an interface, you are prevented from 
disabling it on that interface. To switch to another interface, specify hacheck=yes/1 for a different interface. You cannot 
disable this parameter by specifying hacheck=no/0.		
										false
										false
										
									

									

										-GWIface
                                        
										Specifies if this is a network gateway interface.
0 - Disabled
1 - Enabled
If enabling this option, you must then run the following command: Set-LmParameter -Param dfltgw <NewGatewayIPAddress>		
										false
										false
										
									

									

										-clupdate
                                        
										Enable this to use this interface for cluster synchronization operations.
There must be exactly one interface that is configured for cluster updates. The default interface used for updates is eth0. 
When this option is enabled for an interface, you are prevented from disabling it on that interface. To switch to another 
interface, specify clupdate=yes/1 for a different interface. You cannot disable this parameter by specifying clupdate=no/0.		
										false
										false
										
									

									

										-GeoTraffic
                                        
										Specify whether or not to use this interface for GEO responses and requests.
										false
										false
										
									

									

										-BondMode
                                        
										The bond mode determines the way in which traffic sent out of the bonded interface is actually dispersed over the real 
interfaces.		
										false
										false
										
									

									

										-Partner
                                        
										IP address of the partner machine (HA only).
										false
										false
										
									

									

										-Shared
                                        
										IP address of the shared address (HA only).
										false
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Set-NetworkInterface -MTU 1400

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.
Id               : 0
IPAddress        : 10.154.11.180/16
Mtu              : 1400
InterfaceType    : Port
GeoTrafficEnable : yes
DefaultInterface : yes

                            

						

                        
Top of page
				

				

					

						
 Set-NetworkOptions 

						
WARNING: This function is deprecated. Use the following command instead:
Set-NetworkConfiguration

						
WARNING: This function is deprecated. Use the following command instead:
Set-NetworkConfiguration

					

                        

                        
 Syntax 

                        

						

                            


Set-NetworkOptions [-SNAT <Boolean>] [-AllowUpload <Boolean>] [-ConnTimeout <Int64>] [-KeepAlive <Boolean>] [-MultiGW 
<Boolean>] [-NonLocalRS <Boolean>] [-OnlyDefaultRoutes <Boolean>] [-ResetClose <Boolean>] [-SubnetOrigin <Boolean>] 
[-SubnetOriginating <Boolean>] [-TCPTimeStamp <Boolean>] [-RouteFilter <Boolean>] [-DHKeySize <Int32>] [-Http_Proxy 
<String>] [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction <ActionPreference>] 
[-InformationVariable <String>] [<CommonParameters>]

Set-NetworkOptions [-SNAT <Boolean>] [-AllowUpload <Boolean>] [-ConnTimeout <Int64>] [-KeepAlive <Boolean>] [-MultiGW 
<Boolean>] [-NonLocalRS <Boolean>] [-OnlyDefaultRoutes <Boolean>] [-ResetClose <Boolean>] [-SubnetOrigin <Boolean>] 
[-SubnetOriginating <Boolean>] [-TCPTimeStamp <Boolean>] [-RouteFilter <Boolean>] [-DHKeySize <Int32>] [-Http_Proxy 
<String>] [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN <String>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-SNAT
                                        
										
										false
										false
										
									

									

										-AllowUpload
                                        
										
										false
										false
										
									

									

										-ConnTimeout
                                        
										
										false
										false
										
									

									

										-KeepAlive
                                        
										
										false
										false
										
									

									

										-MultiGW
                                        
										
										false
										false
										
									

									

										-NonLocalRS
                                        
										
										false
										false
										
									

									

										-OnlyDefaultRoutes
                                        
										
										false
										false
										
									

									

										-ResetClose
                                        
										
										false
										false
										
									

									

										-SubnetOrigin
                                        
										
										false
										false
										
									

									

										-SubnetOriginating
                                        
										
										false
										false
										
									

									

										-TCPTimeStamp
                                        
										
										false
										false
										
									

									

										-RouteFilter
                                        
										
										false
										false
										
									

									

										-DHKeySize
                                        
										
										false
										false
										
									

									

										-Http_Proxy
                                        
										
										false
										false
										
									

									

										-LoadBalancer
                                        
										
										false
										false
										
									

									

										-LBPort
                                        
										
										false
										false
										
									

									

										-Credential
                                        
										
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										
										false
										false
										
									

									

										-SubjectCN
                                        
										
										false
										false
										
									

								
							

						
				
				

				

					

						
 Set-NetworkSNMPConfiguration 

						
Allows you to set the values of the various SNMP options.

						
Allows you to set the values of the various SNMP options.

					

                        

                        
 Syntax 

                        

						

                            


Set-NetworkSNMPConfiguration [-SNMPEnable <Boolean>] [-SNMPv3enable <Boolean>] [-SNMPv3user <String>] [-SNMPv3userpasswd 
<String>] [-snmpAuthProt <String>] [-snmpPrivProt <String>] [-SNMPClient <String>] [-SNMPCommunity <String>] [-SNMPContact 
<String>] [-SNMPLocation <String>] [-SNMPTrapEnable <Boolean>] [-SNMPHaTrap <Boolean>] [-SNMPv1Sink <String>] [-SNMPv2Sink 
<String>] [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction <ActionPreference>] 
[-InformationVariable <String>] [<CommonParameters>]

Set-NetworkSNMPConfiguration [-SNMPEnable <Boolean>] [-SNMPv3enable <Boolean>] [-SNMPv3user <String>] [-SNMPv3userpasswd 
<String>] [-snmpAuthProt <String>] [-snmpPrivProt <String>] [-SNMPClient <String>] [-SNMPCommunity <String>] [-SNMPContact 
<String>] [-SNMPLocation <String>] [-SNMPTrapEnable <Boolean>] [-SNMPHaTrap <Boolean>] [-SNMPv1Sink <String>] [-SNMPv2Sink 
<String>] [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN <String>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-SNMPEnable
                                        
										Enable or disable SNMP.
										false
										false
										
									

									

										-SNMPv3enable
                                        
										Enable SNMP V3.
   0 - Disabled
   1 - Enabled		
										false
										false
										
									

									

										-SNMPv3user
                                        
										Specify the username.
										false
										false
										
									

									

										-SNMPv3userpasswd
                                        
										Specify the user password.
										false
										false
										
									

									

										-snmpAuthProt
                                        
										Specify the relevant authentication protocol:
   - MD5
   - SHA


SHA is a more secure protocol.
Note: These values are case sensitive - please enter them in uppercase.		
										false
										false
										
									

									

										-snmpPrivProt
                                        
										Specify the relevant privacy protocol:
   - DES
   - AES


AES is a more secure protocol.
Note: These values are case sensitive - please enter them in uppercase.		
										false
										false
										
									

									

										-SNMPClient
                                        
										Specify the list of machines that can access the SNMP subsystem. If no clients are specified, then anyone can access SNMP.
										false
										false
										
									

									

										-SNMPCommunity
                                        
										Specify the SNMP community string.
										false
										false
										
									

									

										-SNMPContact
                                        
										Specify the contact address that is sent in SNMP responses.
										false
										false
										
									

									

										-SNMPLocation
                                        
										Specify the location that is sent in SNMP responses.
										false
										false
										
									

									

										-SNMPTrapEnable
                                        
										Enable the generation of SNMP events whenever a significant event occurs.
										false
										false
										
									

									

										-SNMPHaTrap
                                        
										Send SNMP traps from the shared IP address. This option is only available when the LoadMaster is in HA mode.
										false
										false
										
									

									

										-SNMPv1Sink
                                        
										Specify the sink address for SNMP type 1 traps.
										false
										false
										
									

									

										-SNMPv2Sink
                                        
										Specify the sink address for SNMP type 2 traps.
										false
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
						

                            

                                
 Note 

                            

							
The generic Get-Parameter and Set-Parameter commands can also be used to retrieve and update these parameters.

						

                        

                            
 Examples 

                        

						

                            

							    Example

Set-NetworkSNMPConfiguration -SNMPv3enable 1

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed; Data=}
Return Code..: 200
Response.....: Command successfully executed
SNMPEnable       : yes
SNMPv3enable     : yes
SNMPv3user       : 
SNMPv3userpasswd : ********
snmpAuthProt     : 
snmpPrivProt     : 
SNMPClient       : 
SNMPCommunity    : 
SNMPContact      : 
SNMPLocation     : 
SNMPTrapEnable   : no

                            

						

                        
Top of page
				

				

					

						
 Set-PacketFilterOptionACL 

						
Sets a packet filtering option.

						
Sets a packet filtering option. This can also be used to enable or disable packet filtering. Note that packet filtering 
cannot be disabled if the GEO feature is enabled.

					

                        

                        
 Syntax 

                        

						

                            


Set-PacketFilterOptionACL -Option <String> -Value <Boolean> [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential 
<Object>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Set-PacketFilterOptionACL -Option <String> -Value <Boolean> [-LoadBalancer <String>] [-LBPort <Int32>] 
[-CertificateStoreLocation <String>] [-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable 
<String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-Option
                                        
										The following packet filtering options are supported: enable, drop or ifblock:
The enable option indicates whether packet filtering is enabled or disabled on the LoadMaster. Note that packet filtering 
is enabled by default and cannot be disabled if the GEO feature is enabled.
If packet filtering is enabled, the drop option indicates whether the LoadMaster silently drops blocked packets or rejects 
them by responding with an ICMP reject packet. For security reasons it is usually best to drop any blocked packets silently.
If packet filtering is enabled, the ifblock option indicates whether the LoadMaster restricts network traffic by imposing 
restrictions upon routing between attached subnets.		
										true
										false
										
									

									

										-Value
                                        
										pecify whether to enable or disable the specified Option:
   0 – Disabled
   1 – Enabled		
										true
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Set-PacketFilterOptionACL -Option drop -Value 0

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.

                            

						

                        
Top of page
				

				

					

						
 Set-Parameter 

						
WARNING: This function is deprecated. Use the following command instead:
Set-LmParameter

						
WARNING: This function is deprecated. Use the following command instead:
Set-LmParameter

					

                        

                        
 Syntax 

                        

						

                            


Set-Parameter -Param <String> -Value <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Set-Parameter -Param <String> -Value <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation 
<String>] [-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-Param
                                        
										
										true
										false
										
									

									

										-Value
                                        
										
										true
										false
										
									

									

										-LoadBalancer
                                        
										
										false
										false
										
									

									

										-LBPort
                                        
										
										false
										false
										
									

									

										-Credential
                                        
										
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										
										false
										false
										
									

									

										-SubjectCN
                                        
										
										false
										false
										
									

								
							

						
				
				

				

					

						
 Set-RealServer 

						
WARNING: This function is deprecated. Use the following command instead:
Set-AdcRealServer

						
WARNING: This function is deprecated. Use the following command instead:
Set-AdcRealServer

					

                        

                        
 Syntax 

                        

						

                            


Set-RealServer [-VirtualService <String>] [-VSPort <Int32>] [-VSProtocol <String>] [-VSIndex <Int32>] [-RealServer 
<String>] [-RealServerPort <Int32>] [-RSIndex <Int32>] [-NewPort <Int32>] [-Weight <Int32>] [-Forward <String>] [-Enable 
<Boolean>] [-Limit <Int64>] [-Critical <Boolean>] [-Follow <Int32>] [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential 
<Object>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Set-RealServer [-VirtualService <String>] [-VSPort <Int32>] [-VSProtocol <String>] [-VSIndex <Int32>] [-RealServer 
<String>] [-RealServerPort <Int32>] [-RSIndex <Int32>] [-NewPort <Int32>] [-Weight <Int32>] [-Forward <String>] [-Enable 
<Boolean>] [-Limit <Int64>] [-Critical <Boolean>] [-Follow <Int32>] [-LoadBalancer <String>] [-LBPort <Int32>] 
[-CertificateStoreLocation <String>] [-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable 
<String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-VirtualService
                                        
										
										false
										false
										
									

									

										-VSPort
                                        
										
										false
										false
										
									

									

										-VSProtocol
                                        
										
										false
										false
										
									

									

										-VSIndex
                                        
										
										false
										false
										
									

									

										-RealServer
                                        
										
										false
										false
										
									

									

										-RealServerPort
                                        
										
										false
										false
										
									

									

										-RSIndex
                                        
										
										false
										false
										
									

									

										-NewPort
                                        
										
										false
										false
										
									

									

										-Weight
                                        
										
										false
										false
										
									

									

										-Forward
                                        
										
										false
										false
										
									

									

										-Enable
                                        
										
										false
										false
										
									

									

										-Limit
                                        
										
										false
										false
										
									

									

										-Critical
                                        
										
										false
										false
										
									

									

										-Follow
                                        
										
										false
										false
										
									

									

										-LoadBalancer
                                        
										
										false
										false
										
									

									

										-LBPort
                                        
										
										false
										false
										
									

									

										-Credential
                                        
										
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										
										false
										false
										
									

									

										-SubjectCN
                                        
										
										false
										false
										
									

								
							

						
				
				

				

					

						
 Set-Rule 

						
WARNING: This function is deprecated. Use the following command instead:
Set-AdcContentRule

						
WARNING: This function is deprecated. Use the following command instead:
Set-AdcContentRule

					

                        

                        
 Syntax 

                        

						

                            


Set-Rule -RuleName <String> [-MatchType <String>] [-IncHost <Boolean>] [-NoCase <Boolean>] [-Negate <Boolean>] [-IncQuery 
<Boolean>] [-Header <String>] [-Pattern <String>] [-Replacement <String>] [-Type <Int32>] [-LoadBalancer <String>] [-LBPort 
<Int32>] [-Credential <Object>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Set-Rule -RuleName <String> [-MatchType <String>] [-IncHost <Boolean>] [-NoCase <Boolean>] [-Negate <Boolean>] [-IncQuery 
<Boolean>] [-Header <String>] [-Pattern <String>] [-Replacement <String>] [-Type <Int32>] [-LoadBalancer <String>] [-LBPort 
<Int32>] [-CertificateStoreLocation <String>] [-SubjectCN <String>] [-InformationAction <ActionPreference>] 
[-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-RuleName
                                        
										
										true
										false
										
									

									

										-MatchType
                                        
										
										false
										false
										
									

									

										-IncHost
                                        
										
										false
										false
										
									

									

										-NoCase
                                        
										
										false
										false
										
									

									

										-Negate
                                        
										
										false
										false
										
									

									

										-IncQuery
                                        
										
										false
										false
										
									

									

										-Header
                                        
										
										false
										false
										
									

									

										-Pattern
                                        
										
										false
										false
										
									

									

										-Replacement
                                        
										
										false
										false
										
									

									

										-Type
                                        
										
										false
										false
										
									

									

										-LoadBalancer
                                        
										
										false
										false
										
									

									

										-LBPort
                                        
										
										false
										false
										
									

									

										-Credential
                                        
										
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										
										false
										false
										
									

									

										-SubjectCN
                                        
										
										false
										false
										
									

								
							

						
				
				

				

					

						
 Set-SAMLSPEntity 

						
Use this command to set values for some SAML-related parameters.

						
Use this command to set values for some SAML-related parameters.

					

                        

                        
 Syntax 

                        

						

                            


Set-SAMLSPEntity -Domain <String> [-IdpEntityId <String>] [-IdpSsoUrl <String>] [-IdpLogoffUrl <String>] [-IdpCert 
<String>] [-SpEntityId <String>] [-SpCert <String>] [-idp_match_cert <Int32>] [-LoadBalancer <String>] [-LBPort <Int32>] 
[-Credential <Object>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Set-SAMLSPEntity -Domain <String> [-IdpEntityId <String>] [-IdpSsoUrl <String>] [-IdpLogoffUrl <String>] [-IdpCert 
<String>] [-SpEntityId <String>] [-SpCert <String>] [-idp_match_cert <Int32>] [-LoadBalancer <String>] [-LBPort <Int32>] 
[-CertificateStoreLocation <String>] [-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable 
<String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-Domain
                                        
										The domain name of the relevant domain to be updated.
										true
										false
										
									

									

										-IdpEntityId
                                        
										Specify the Identity Service Provider (IdP) Entity ID.
										false
										false
										
									

									

										-IdpSsoUrl
                                        
										Specify the IdP Single Sign On (SSO) URL.
										false
										false
										
									

									

										-IdpLogoffUrl
                                        
										Specify the IdP Logoff URL.
										false
										false
										
									

									

										-IdpCert
                                        
										Specify the IdP certificate to use for verification processing.
										false
										false
										
									

									

										-SpEntityId
                                        
										The Service Provider (SP) entity ID is an identifier that is shared to enable the IdP to understand, accept and have 
knowledge of the entity when request messages are sent from the LoadMaster. This must correlate to the identifier of the 
relying party on the AD FS server.		
										false
										false
										
									

									

										-SpCert
                                        
										It is optional to sign requests that are sent in the context of logon. Currently, the LoadMaster does not sign those 
requests. 
In the context of log off requests – it is mandatory and these requests must be signed. This is to avoid any spoofing and 
to provide extra security in relation to log off functionality. This ensures that users are not being hacked and not being 
logged off unnecessarily.
Using the SpCert parameter, you can choose to use a self-signed certificate or third party certificate to perform the 
signing.
To specify a self-signed certificate, set sp_cert to useselfsigned. To use a third party certificate, specify the name of 
the certificate to use (this certificate must be uploaded to the LoadMaster before it can be selected).		
										false
										false
										UseSelfSigned
									

									

										-idp_match_cert
                                        
										If this option is enabled, the IdP certificate assigned must match the certificate in the IdP SAML response.
Range:
0 - Disabled
1 - Enabled		
										false
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Set-SAMLSPEntity -Domain example2.com -IdpEntityId idp-3.example.com -IdpSsoUrl example.com -IdpLogoffUrl example.com/logoff -SpEntityId exampleID -SpCert useselfsigned -idp_match_cert 1

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.
Data field...: @{Domain=}
Param........: @{Id=3; Name=EXAMPLE2.COM; auth_type=SAML; idp_entity_id=idp-3.example.com; idp_sso_url=http://example.com; 
idp_logoff_ur...
Id                     : 3
Name                   : EXAMPLE2.COM
auth_type              : SAML
idp_entity_id          : idp-3.example.com
idp_sso_url            : 
idp_logoff_url         : 
idp_cert               : 
idp_match_cert         : 1
sp_entity_id           : 
sp_cert                : UseSelfSigned
sess_tout_type         : idle time
sess_tout_idle_pub     : 900
sess_tout_duration_pub : 1800

                            

						

                        
Top of page
				

				

					

						
 Set-SdnController 

						
Used to change the details of an SDN controller.

						
Used to change the details of an SDN controller.

					

                        

                        
 Syntax 

                        

						

                            


Set-SdnController -Cid <Int32> [-Clid <Int32>] [-IPV4 <String>] [-Port <Int32>] [-Https <Boolean>] [-User <String>] 
[-Password <String>] [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Set-SdnController -Cid <Int32> [-Clid <Int32>] [-IPV4 <String>] [-Port <Int32>] [-Https <Boolean>] [-User <String>] 
[-Password <String>] [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN <String>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-Cid
                                        
										The ID of the controller to be modified. To get the controller ID, run the getsdncontroller command.
										true
										false
										
									

									

										-Clid
                                        
										The cluster ID for the SDN controller for changing.
										false
										false
										
									

									

										-IPV4
                                        
										The IPv4 address of the SDN controller.
										false
										false
										
									

									

										-Port
                                        
										The port of the SDN controller.
										false
										false
										
									

									

										-Https
                                        
										The HTTP method to use.
										false
										false
										
									

									

										-User
                                        
										The username to be used to access the SDN controller PowerShell API.
										false
										false
										
									

									

										-Password
                                        
										The password to be used to access the SDN controller PowerShell API.
										false
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
						

                            

                                
 Note 

                            

							
If any mandatory parameters are missing, you will be prompted to enter them.

						

                        

                            
 Examples 

                        

						

                            

							    Example

Set-SdnController -Cid 56 -Https 0

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=Data}
Return Code..: 200
Response.....: Command successfully executed.

                            

						

                        
Top of page
				

				

					

						
 Set-SecAdminAccess 

						
Allows you to set the web administrative access interface and the administrative default gateway.

						
Allows you to set the web administrative access interface and the administrative default gateway.

					

                        

                        
 Syntax 

                        

						

                            


Set-SecAdminAccess -WuiNetworkInterfaceId <Int32> -WuiPort <Int32> [-WuiDefaultGateway <String>] [-LoadBalancer <String>] 
[-LBPort <Int32>] [-Credential <Object>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] 
[<CommonParameters>]

Set-SecAdminAccess -WuiNetworkInterfaceId <Int32> -WuiPort <Int32> [-WuiDefaultGateway <String>] [-LoadBalancer <String>] 
[-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN <String>] [-InformationAction <ActionPreference>] 
[-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-WuiNetworkInterfaceId
                                        
										The index of an existing interface. This index number corresponds to the interface number in the LoadMaster WUI, i.e. the 
index for eth0 is 0.		
										true
										false
										
									

									

										-WuiPort
                                        
										Specify the port used to access the administrative web interface.
										true
										false
										
									

									

										-WuiDefaultGateway
                                        
										When administering the LoadMaster from a non-default interface, a different default gateway for administrative traffic only 
can be specified using this parameter.		
										false
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Set-SecAdminAccess -WuiNetworkInterfaceId 0 -WuiPort 443

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.
Data field...: @{SecAdminAccessConfiguration=}
Param........: @{WuiDefaultGateway=; WuiNetworkInterfaceId=0; WuiPort=443}

                            

						

                        
Top of page
				

				

					

						
 Set-SecAdminWuiConfiguration 

						
Configure the admin WUI configuration settings.

						
Set parameters such as the WUICipherset and WUITLSProtocols.

					

                        

                        
 Syntax 

                        

						

                            


Set-SecAdminWuiConfiguration [-WUITLSProtocols <Int32>] [-WUICipherset <String>] [-sessioncontrol <Boolean>] 
[-sessionbasicauth <Boolean>] [-sessionmaxfailattempts <Int16>] [-sessionidletime <Int32>] [-sessionconcurrent <Int16>] 
[-wuipreauth <String>] [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Set-SecAdminWuiConfiguration [-WUITLSProtocols <Int32>] [-WUICipherset <String>] [-sessioncontrol <Boolean>] 
[-sessionbasicauth <Boolean>] [-sessionmaxfailattempts <Int16>] [-sessionidletime <Int32>] [-sessionconcurrent <Int16>] 
[-wuipreauth <String>] [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN 
<String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-WUITLSProtocols
                                        
										Specify whether or not it is possible to connect to the LoadMaster WUI using the following protocols; SSLv3, TLS1.0, 
TLS1.1, TLS1.2, or TLS1.3. The protocols can be enabled and disabled using a bitmask value in the range 0 to 30. Refer to 
the table below to find out what number corresponds to which settings.
Number |   SSLv3      | TLS1.0     | TLS1.1      | TLS1.2         | TLS1.3
0            |   Enabled   | Enabled  | Enabled   | Enabled       |  Enabled
1            |   Disabled  | Enabled  | Enabled   | Enabled       | Enabled
2            |   Enabled   | Disabled | Enabled   | Enabled       | Enabled
3            |   Disabled  | Disabled | Enabled   | Enabled       | Enabled
4            |   Enabled   | Enabled  | Disabled  | Enabled       | Enabled
5            |   Disabled  | Enabled  | Disabled  | Enabled       | Enabled
6            |   Enabled   | Disabled | Disabled  | Enabled       | Enabled
7            |   Disabled  | Disabled | Disabled  | Enabled       | Enabled
8            |   Enabled   | Enabled  | Enabled   | Disabled      | Enabled
9            |   Disabled  | Enabled  | Enabled   | Disabled      | Enabled
10          |   Enabled   | Disabled | Enabled   | Disabled      | Enabled
11          |   Disabled  | Disabled | Enabled   | Disabled      | Enabled
12          |   Enabled   | Enabled  | Disabled  | Disabled      | Enabled
13          |   Disabled  | Enabled  | Disabled  | Disabled      | Enabled
14          |   Enabled   | Disabled | Disabled  | Disabled      | Enabled
15          |   Disabled  | Disabled | Disabled  | Disabled      | Enabled
16          |   Enabled   | Enabled  | Enabled   | Enabled       | Disabled
17          |   Disabled |  Enabled  | Enabled   | Enabled       | Disabled
18          |   Enabled  |  Disabled | Enabled   | Enabled       | Disabled
19          |   Disabled |  Disabled | Enabled   | Enabled       | Disabled
20          |   Enabled  |  Enabled  | Disabled  | Enabled       | Disabled
21          |   Disabled |  Enabled  | Disabled  | Enabled       | Disabled
22          |   Enabled  |  Disabled | Disabled  | Enabled       | Disabled
23          |   Disabled |  Disabled | Disabled  | Enabled       | Disabled
24          |   Enabled  |   Enabled | Enabled   | Disabled      | Disabled
25          |   Disabled |   Enabled | Enabled   | Disabled      | Disabled
26          |   Enabled  |   Disabled | Enabled  | Disabled      | Disabled
27          |   Disabled |   Disabled | Enabled  | Disabled      | Disabled
28          |   Enabled  |   Enabled  | Disabled | Disabled      | Disabled
29          |   Disabled |   Enabled  | Disabled | Disabled      | Disabled
30          |   Enabled  |   Disabled | Disabled | Disabled      | Disabled		
										false
										false
										
									

									

										-WUICipherset
                                        
										Specify the cipher set to use for the LoadMaster WUI.
The valid values are below:
- Default
- Default_NoRc4
- BestPractices
- Intermediate_compatibility
- Backward_compatibility
- WUI
- FIPS
- Legacy
- <NameOfCustomCipherSet> Specify the cipher set to use for the LoadMaster WUI.		
										false
										false
										
									

									

										-sessioncontrol
                                        
										Enables or disables session control.
										false
										false
										
									

									

										-sessionbasicauth
                                        
										If the SessionControl and SessionBasicAuth parameters are both enabled, there are two levels of authentication enforced in 
order to access the LoadMaster WUI. The initial level is Basic Authentication where users log in using the bal or user 
logins, which are default usernames defined by the system.		
										false
										false
										
									

									

										-sessionmaxfailattempts
                                        
										Number of failed attempts before locking the user account. This can be set from 1 to 999.
										false
										false
										
									

									

										-sessionidletime
                                        
										Specifies the number of seconds that the WUI can be idle before logging the user out. This can be set from 60 to 86400 
seconds.		
										false
										false
										
									

									

										-sessionconcurrent
                                        
										Limit the maximum number of concurrent connections a single user can have. 
Range: 0 to 9. A value of 0, means logins are unlimited.		
										false
										false
										
									

									

										-wuipreauth
                                        
										Set the pre-authentication click through banner which will be displayed before the LoadMaster login page. This parameter 
can contain plain text or HTML code. The field cannot contain JavaScript. This field accepts up to 5,000 characters. 
Anything past the 5,000 character limit will not be displayed.		
										false
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Set-SecAdminWuiConfiguration

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.
Data field...: @{Parameters=}
Param........: @{sessionmaxfailattempts=5}

                            

						

                        
Top of page
				

				

					

						
 Set-SecRemoteAccess 

						
Allows you to set the values of Remote Access options.

						
Allows you to set the values of Remote Access options.

					

                        

                        
 Syntax 

                        

						

                            


Set-SecRemoteAccess [-SSHAccess <Boolean>] [-SSHIface <String>] [-SSHPort <Int32>] [-SSHPreAuthBanner <String>] [-WUIAccess 
<Boolean>] [-MultiHomedWui <Boolean>] [-EnableAPI <Boolean>] [-AllowUpdateChecks <Boolean>] [-GeoClients <String>] 
[-GeoPartners <String>] [-GeoSSHPort <Int32>] [-geo_ssh_iface <Int32>] [-LoadBalancer <String>] [-LBPort <Int32>] 
[-Credential <Object>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Set-SecRemoteAccess [-SSHAccess <Boolean>] [-SSHIface <String>] [-SSHPort <Int32>] [-SSHPreAuthBanner <String>] [-WUIAccess 
<Boolean>] [-MultiHomedWui <Boolean>] [-EnableAPI <Boolean>] [-AllowUpdateChecks <Boolean>] [-GeoClients <String>] 
[-GeoPartners <String>] [-GeoSSHPort <Int32>] [-geo_ssh_iface <Int32>] [-LoadBalancer <String>] [-LBPort <Int32>] 
[-CertificateStoreLocation <String>] [-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable 
<String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-SSHAccess
                                        
										Specify over which addresses remote administrative SSH access to the LoadMaster is allowed.
										false
										false
										
									

									

										-SSHIface
                                        
										Specify the addresses over which remote administrative SSH access to the LoadMaster is allowed.
										false
										false
										
									

									

										-SSHPort
                                        
										Specify the port used to access the LoadMaster via the SSH protocol.
										false
										false
										
									

									

										-SSHPreAuthBanner
                                        
										Set the SSH pre-authentication banner, which is displayed before the login prompt when logging in using SSH. Space 
characters should be escaped by entering %20.
This field accepts up to 5,000 characters. Anything past the 5,000 character limit will not be displayed.		
										false
										false
										
									

									

										-WUIAccess
                                        
										Enables or disables WUI access.
										false
										false
										
									

									

										-MultiHomedWui
                                        
										Allow WUI access from multiple interfaces. Apart from the main administrative interface, each interface can then be enabled 
to allow WUI access.		
										false
										false
										
									

									

										-EnableAPI
                                        
										The EnableAPI parameter is deprecated. Please use the Enable/Disable-SecAPIAccess commands instead.
										false
										false
										
									

									

										-AllowUpdateChecks
                                        
										Allow the LoadMaster to regularly check the Kemp website for new software versions.
										false
										false
										
									

									

										-GeoClients
                                        
										Set the addresses of the GEO LoadMasters which can retrieve service status information from the LoadMaster.
To unset this, set the value to an empty string.		
										false
										false
										
									

									

										-GeoPartners
                                        
										Set the IP address of the GEO LoadMaster partner(s). These GEO LoadMasters will keep their DNS configurations in sync.
To unset this, set the value to an empty string.


Note: Before partnering GEO LoadMasters, a backup should be taken of the relevant GEO LoadMaster which has the 
correct/preferred configuration. This backup should then be restored to the other LoadMasters that will be partnered with 
the original LoadMaster.		
										false
										false
										
									

									

										-GeoSSHPort
                                        
										The port over which GEO LoadMasters will communicate with on another.
										false
										false
										
									

									

										-geo_ssh_iface
                                        
										Specify the ID of the GEO interface in which the SSH partner tunnel is created, for example setting this to 0 means the 
interface eth0. This is the interface that the GEO partners will communicate through.		
										false
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-GeoInterfaceId
                                        
										Specify the ID of the GEO interface in which the SSH partner tunnel is created, for example setting this to 0 means the 
interface eth0. This is the interface that the GEO partners will communicate through.		
										false
										false
										
									

								
							

						
				
						

                            

                                
 Note 

                            

							
This is a legacy command and cannot be used to set all of the available parameters. Please refer to the Get-Help of the 
    Set-Parameter command to view a full list of parameters that can be configured.

						

                        

                            
 Examples 

                        

						

                            

							    Example

Set-SecRemoteAccess -GeoPartners 10.154.11.34

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.
Param........: @{GeoPartners=10.154.11.34}

                            

						

                        
Top of page
				

				

					

						
 Set-SecRemoteAccessLoginMethod 

						
Configure the Admin Login Method for the LoadMaster Web User Interface (WUI).

						
This command sets the Admin Login Method for the WUI, for example, to "Password or Client certificate" or "Password Only 
Access (default)".

					

                        

                        
 Syntax 

                        

						

                            


Set-SecRemoteAccessLoginMethod -LoginMethod <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Set-SecRemoteAccessLoginMethod -LoginMethod <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation 
<String>] [-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-LoginMethod
                                        
										Specify the login method. Valid values are:
PasswordOnly
PasswordorClientCertificate
ClientCertificateRequired
ClientCertificateRequiredOCSP		
										true
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Set-SecRemoteAccessLoginMethod -LoginMethod PasswordOnly

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.

                            

						

                        
Top of page
				

				

					

						
 Set-SecRemoteUserGroup 

						
Configure permissions for a remote user group.

						
These groups can be used to provide WUI authentication.

					

                        

                        
 Syntax 

                        

						

                            


Set-SecRemoteUserGroup -Group <String> -Permissions <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential 
<Object>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Set-SecRemoteUserGroup -Group <String> -Permissions <String> [-LoadBalancer <String>] [-LBPort <Int32>] 
[-CertificateStoreLocation <String>] [-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable 
<String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-Group
                                        
										Specify the name of the group you want to edit.
										true
										false
										
									

									

										-Permissions
                                        
										Valid values for the perms parameter are listed and described below. 
Multiple permissions can be set at the same time by separating the values with a comma, and surrounding the value list with 
double quotes, for example -Permissions "vs,geo".


real: This role permits enabling and disabling Real Servers. Users with the Real Servers permission cannot add SubVSs.
vs: This role permits managing Virtual Services. This includes SubVSs. Virtual Service modifications permitted include add, 
delete and modify for any subnet.
rules: This role permits managing Rules. Rule modifications permitted include add, delete and modify.
backup: This role permits performing system backups.
certs: This role permits managing SSL Certificates. Certificate management includes adding, deleting and modifying SSL 
Certificates.
cert3: This role permits managing intermediate Certificates. Certificate management includes the ability to add and delete 
intermediate certificates.
certbackup: This role permits the ability to export and import certificates.
users: This role is allowed access to all functionality within the System Configuration > System Administration > User 
Management WUI screen.
root: This role gives users all permissions except the permission to change the bal password and the permission to create 
or delete other users.
geo: This role is used only with the LoadMaster GEO product. For more information on GEO and the Global Server Load 
Balancing (GSLB) Feature Pack, refer to the GEO, Product Overview.		
										true
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Set-SecRemoteUserGroup -Group ExampleGroup3 -Permissions "real,vs,geo"

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.

                            

						

                        
Top of page
				

				

					

						
 Set-SecSystemUserPassword 

						
Allows you to change the password of the default bal user.

						
Allows you to change the password of the default bal user.

					

                        

                        
 Syntax 

                        

						

                            


Set-SecSystemUserPassword [-CurrentPassword] <String> [-NewPassword] <String> [[-LoadBalancer] <String>] [[-LBPort] 
<Int32>] [[-Credential] <Object>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] 
[<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-CurrentPassword
                                        
										The current password for the bal user.
										true
										false
										
									

									

										-NewPassword
                                        
										The new password for the bal user.
										true
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Set-SecSystemUserPassword -CurrPassword 1fourall -Password 2fourall

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.

                            

						

                        
Top of page
				

				

					

						
 Set-SecUserPassword 

						
Allows you to change the password of a local user.

						
Allows you to change the password of a local user.

					

                        

                        
 Syntax 

                        

						

                            


Set-SecUserPassword -User <String> -Password <String> -Radius <Int32> [-LoadBalancer <String>] [-LBPort <Int32>] 
[-Credential <Object>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Set-SecUserPassword -User <String> -Password <String> -Radius <Int32> [-LoadBalancer <String>] [-LBPort <Int32>] 
[-CertificateStoreLocation <String>] [-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable 
<String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-User
                                        
										Username of the relevant user.
										true
										false
										
									

									

										-Password
                                        
										The new password.
										true
										false
										
									

									

										-Radius
                                        
										The radius parameter determines whether the user will use RADIUS server authentication or not when logging in to the 
LoadMaster. The RADIUS server details must be set up before this option can be used.
0 - Do not use RADIUS authentication
1 - Use RADIUS authentication		
										true
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Set-SecUserPassword -Password password12345 -Radius 0 -User ExampleUser

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.

                            

						

                        
Top of page
				

				

					

						
 Set-SecUserPermission 

						
Allows you to set permissions for a local user.

						
When entering a comma-separated list of multiple permissions, ensure to begin the value entry with a comma, for example 
,rules,vs.

					

                        

                        
 Syntax 

                        

						

                            


Set-SecUserPermission -User <String> -Permissions <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential 
<Object>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Set-SecUserPermission -User <String> -Permissions <String> [-LoadBalancer <String>] [-LBPort <Int32>] 
[-CertificateStoreLocation <String>] [-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable 
<String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-User
                                        
										Username of the relevant user.
										true
										false
										
									

									

										-Permissions
                                        
										Valid values for the perms parameter are listed and described below.


real: This role permits enabling and disabling Real Servers. Users with the Real Servers permission cannot add SubVSs.
vs: This role relates to managing Virtual Services. This includes SubVSs. Virtual Service actions permitted vary depending 
on whether or not the extendedperms parameter is enabled. For further information, refer to the User Management Feature 
Description on the Kemp Documentation Page: https://kemptechnologies.com/loadmaster-documentation/
rules: This role permits managing Rules. Rule modifications permitted include add, delete and modify.
backup: This role permits performing system backups.
certs: This role permits managing SSL Certificates. Certificate management includes adding, deleting and modifying SSL 
Certificates.
cert3: This role permits managing intermediate Certificates. Certificate management includes the ability to add and delete 
intermediate certificates.
certbackup: This role permits the ability to export and import certificates.
users: This role is allowed access to all functionality within the System Configuration > System Administration > User 
Management WUI screen.
root: This role gives users all permissions except the permission to change the bal password and the permission to create 
or delete other users.
geo: This role is used only with the LoadMaster GEO product. For more information on GEO and the Global Server Load 
Balancing (GSLB) Feature Pack, refer to the GEO, Product Overview.
addvs: This parameter can only be enabled if the extendedperms parameter is enabled. This role relates to managing Virtual 
Services. This includes SubVSs. Refer to the UserManagement Feature Description on the Kemp Documentation Page 
(https://kemptechnologies.com/loadmaster-documentation/) forfurther details on the permissions provided by this option.


Multiple permissions can be set at the same time by separating the values with a comma.		
										true
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-Perms
                                        
										The valid values for this parameter and their descriptions are below:


real - This role permits enabling and disabling Real Servers. Users with the Real Servers permission cannot add SubVSs.


vs - This role permits managing Virtual Services. This includes SubVSs. Virtual Service modifications permitted include 
add, delete and modify for any subnet.


rules - This role permits managing Rules. Rule modifications permitted include add, delete and modify.


backup - This role permits performing system backups.


certs - This role permits managing SSL Certificates. Certificate management includes adding, deleting and modifying SSL 
Certificates.


cert3 - This role permits managing intermediate Certificates. Certificate management includes the ability to add and delete 
intermediate certificates.


certbackup - This role permits the ability to export and import certificates.


users - This role is allowed access to all functionality within the System Configuration > System Administration > User 
Management WUI screen.


root - This role gives users all permissions except the permission to change the bal password and the permission to create 
or delete other users.


geo - This role is used only with the LoadMaster GEO product. For more information on GEO and the Global Server Load 
Balancing (GSLB) Feature Pack, refer to the GEO, Product Overview.


To set the permissions to none, leave the parameter blank, for example &perms=		
										true
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Set-SecUserPermission -User ExampleUser -Perms ,vs,rules

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.

                            

						

                        
Top of page
				

				

					

						
 Set-SecWuiAuthentication 

						
Allows you to set the values of WUI Authentication and Authorization options.

						
Configure options such as the RADIUS configuration settings.

					

                        

                        
 Syntax 

                        

						

                            


Set-SecWuiAuthentication [-RADIUSServer <String>] [-RADIUSPort <Int64>] [-RADIUSSecret <String>] [-RADIUSBackupServer 
<String>] [-RADIUSBackupPort <Int64>] [-RADIUSBackupSecret <String>] [-RADIUSRevalidateInterval <Int32>] [-WuiLdapEp 
<String>] [-Wuiusergroups <String>] [-Wuinestedgroups <String>] [-SessionLocalAuth <Boolean>] [-SessionAuthMode <Int16>] 
[-WuiDomain <String>] [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Set-SecWuiAuthentication [-RADIUSServer <String>] [-RADIUSPort <Int64>] [-RADIUSSecret <String>] [-RADIUSBackupServer 
<String>] [-RADIUSBackupPort <Int64>] [-RADIUSBackupSecret <String>] [-RADIUSRevalidateInterval <Int32>] [-WuiLdapEp 
<String>] [-Wuiusergroups <String>] [-Wuinestedgroups <String>] [-SessionLocalAuth <Boolean>] [-SessionAuthMode <Int16>] 
[-WuiDomain <String>] [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN <String>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-RADIUSServer
                                        
										Specifies the RADIUS server to use for authentication.
Note: IPv6 is not supported for RADIUS authentication.		
										false
										false
										
									

									

										-RADIUSPort
                                        
										Specifies the TCP port for communication to the RADIUS server.
										false
										false
										
									

									

										-RADIUSSecret
                                        
										Specifies the password (secret) to the RADIUS server.
										false
										false
										
									

									

										-RADIUSBackupServer
                                        
										Specifies the backup RADIUS server to use for authentication.
										false
										false
										
									

									

										-RADIUSBackupPort
                                        
										Specifies the TCP port for the backup RADIUS server.
										false
										false
										
									

									

										-RADIUSBackupSecret
                                        
										Specifies the password (secret) to the backup RADIUS server.
										false
										false
										
									

									

										-RADIUSRevalidateInterval
                                        
										Specifies how often a user should be revalidated by the RADIUS server.
										false
										false
										
									

									

										-WuiLdapEp
                                        
										Specify the LDAP endpoint configuration to use for WUI login authentication.
										false
										false
										
									

									

										-Wuiusergroups
                                        
										Enter a space-separated list of existing remote user groups to assign, for example "testgroup testgroup2". Set the 
parameter to an empty value to remove all assigned groups, for example "".		
										false
										false
										
									

									

										-Wuinestedgroups
                                        
										Enable or disable nested remote user groups.
0 = Disabled
1 = Enabled		
										false
										false
										
									

									

										-SessionLocalAuth
                                        
										Enables or disables local authentication.
										false
										false
										
									

									

										-SessionAuthMode
                                        
										Specifies the authentication mode for the LoadMaster. Refer to the following table for values:
                   RADIUS              LDAP            Local
Value        Authent.    Author.     Authent.    Authent.    Author.
7            No          No          No          No          No
263          Yes         No          No          Yes         Yes
775          Yes         Yes         No          Yes         Yes
23           No          No          Yes         Yes         Yes
22           No          No          Yes         No          Yes
788          Yes         Yes         Yes         No          No
790          Yes         Yes         Yes         No          Yes
791          Yes         Yes         Yes         Yes         Yes
789          Yes         Yes         Yes         Yes         No
773          Yes         Yes         No          Yes         No
262          Yes         No          No          No          Yes
774          Yes         Yes         No          No          Yes
772          Yes         Yes         No          No          No
278          Yes         No          Yes         No          No
279          Yes         No          Yes         Yes         Yes		
										false
										false
										
									

									

										-WuiDomain
                                        
										Specify the domain to use if no domain is provided in the username when group WUI authentication is in use. This value is 
always used as the domain for group search if the Windows logon is used in the format prefix\username.		
										false
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Set-SecWuiAuthentication -RADIUSPort 80

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.
Data field...: @{Parameters=}
Param........: @{RADIUSPort=80}

                            

						

                        
Top of page
				

				

					

						
 Set-ServiceHealth 

						
WARNING: This function is deprecated. Use the following command instead:
Set-AdcServiceHealth

						
WARNING: This function is deprecated. Use the following command instead:
Set-AdcServiceHealth

					

                        

                        
 Syntax 

                        

						

                            


Set-ServiceHealth [-CheckInterval <Int16>] [-ConnectTimeout <Int16>] [-RetryCount <Int16>] [-LoadBalancer <String>] 
[-LBPort <Int32>] [-Credential <Object>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] 
[<CommonParameters>]

Set-ServiceHealth [-CheckInterval <Int16>] [-ConnectTimeout <Int16>] [-RetryCount <Int16>] [-LoadBalancer <String>] 
[-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN <String>] [-InformationAction <ActionPreference>] 
[-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-CheckInterval
                                        
										
										false
										false
										
									

									

										-ConnectTimeout
                                        
										
										false
										false
										
									

									

										-RetryCount
                                        
										
										false
										false
										
									

									

										-LoadBalancer
                                        
										
										false
										false
										
									

									

										-LBPort
                                        
										
										false
										false
										
									

									

										-Credential
                                        
										
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										
										false
										false
										
									

									

										-SubjectCN
                                        
										
										false
										false
										
									

								
							

						
				
				

				

					

						
 Set-SNMPOption 

						
WARNING: This function is deprecated. Use the following command instead:
Set-NetworkSNMPConfiguration

						
WARNING: This function is deprecated. Use the following command instead:
Set-NetworkSNMPConfiguration

					

                        

                        
 Syntax 

                        

						

                            


Set-SNMPOption [-SNMPEnable <Boolean>] [-SNMPv3enable <Boolean>] [-SNMPv3user <String>] [-SNMPv3userpasswd <String>] 
[-snmpAuthProt <String>] [-snmpPrivProt <String>] [-SNMPClient <String>] [-SNMPCommunity <String>] [-SNMPContact <String>] 
[-SNMPLocation <String>] [-SNMPTrapEnable <Boolean>] [-SNMPHaTrap <Boolean>] [-SNMPv1Sink <String>] [-SNMPv2Sink <String>] 
[-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction <ActionPreference>] 
[-InformationVariable <String>] [<CommonParameters>]

Set-SNMPOption [-SNMPEnable <Boolean>] [-SNMPv3enable <Boolean>] [-SNMPv3user <String>] [-SNMPv3userpasswd <String>] 
[-snmpAuthProt <String>] [-snmpPrivProt <String>] [-SNMPClient <String>] [-SNMPCommunity <String>] [-SNMPContact <String>] 
[-SNMPLocation <String>] [-SNMPTrapEnable <Boolean>] [-SNMPHaTrap <Boolean>] [-SNMPv1Sink <String>] [-SNMPv2Sink <String>] 
[-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN <String>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-SNMPEnable
                                        
										
										false
										false
										
									

									

										-SNMPv3enable
                                        
										
										false
										false
										
									

									

										-SNMPv3user
                                        
										
										false
										false
										
									

									

										-SNMPv3userpasswd
                                        
										
										false
										false
										
									

									

										-snmpAuthProt
                                        
										
										false
										false
										
									

									

										-snmpPrivProt
                                        
										
										false
										false
										
									

									

										-SNMPClient
                                        
										
										false
										false
										
									

									

										-SNMPCommunity
                                        
										
										false
										false
										
									

									

										-SNMPContact
                                        
										
										false
										false
										
									

									

										-SNMPLocation
                                        
										
										false
										false
										
									

									

										-SNMPTrapEnable
                                        
										
										false
										false
										
									

									

										-SNMPHaTrap
                                        
										
										false
										false
										
									

									

										-SNMPv1Sink
                                        
										
										false
										false
										
									

									

										-SNMPv2Sink
                                        
										
										false
										false
										
									

									

										-LoadBalancer
                                        
										
										false
										false
										
									

									

										-LBPort
                                        
										
										false
										false
										
									

									

										-Credential
                                        
										
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										
										false
										false
										
									

									

										-SubjectCN
                                        
										
										false
										false
										
									

								
							

						
				
				

				

					

						
 Set-SSODomain 

						
Allows you to set Single Sign-On (SSO) Domain options.

						
Allows you to set Single Sign-On (SSO) Domain options.

					

                        

                        
 Syntax 

                        

						

                            


Set-SSODomain [-Domain <String>] [-TLS <String>] [-Server <String[]>] [-Server2 <String[]>] [-auth_type <String>] 
[-max_failed_auths <Int32>] [-reset_fail_tout <Int32>] [-unblock_tout <Int32>] [-logon_fmt <String>] [-logon_fmt2 <String>] 
[-logon_domain <String>] [-sess_tout_type <String>] [-sess_tout_idle_pub <Int32>] [-sess_tout_duration_pub <Int32>] 
[-sess_tout_idle_priv <Int32>] [-sess_tout_duration_priv <Int32>] [-testuser <String>] [-testpass <String>] [-ldapephc 
<Int32>] [-radius_send_nas_id <Int32>] [-radius_nas_id <String>] [-radius_shared_secret <String>] [-kerberos_domain 
<String>] [-kerberos_kdc <String>] [-kcd_username <String>] [-kcd_password <String>] [-server_side <String>] 
[-cert_check_asi <String>] [-cert_check_cn <String>] [-Logon_Transcode <Boolean>] [-ldap_endpoint <String>] [-LoadBalancer 
<String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] 
[<CommonParameters>]

Set-SSODomain [-Domain <String>] [-TLS <String>] [-Server <String[]>] [-Server2 <String[]>] [-auth_type <String>] 
[-max_failed_auths <Int32>] [-reset_fail_tout <Int32>] [-unblock_tout <Int32>] [-logon_fmt <String>] [-logon_fmt2 <String>] 
[-logon_domain <String>] [-sess_tout_type <String>] [-sess_tout_idle_pub <Int32>] [-sess_tout_duration_pub <Int32>] 
[-sess_tout_idle_priv <Int32>] [-sess_tout_duration_priv <Int32>] [-testuser <String>] [-testpass <String>] [-ldapephc 
<Int32>] [-radius_send_nas_id <Int32>] [-radius_nas_id <String>] [-radius_shared_secret <String>] [-kerberos_domain 
<String>] [-kerberos_kdc <String>] [-kcd_username <String>] [-kcd_password <String>] [-server_side <String>] 
[-cert_check_asi <String>] [-cert_check_cn <String>] [-Logon_Transcode <Boolean>] [-ldap_endpoint <String>] [-LoadBalancer 
<String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN <String>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-Domain
                                        Name
										Specifies the name of the SSO domain LoadMaster entry to be modified.
										false
										true (ByPropertyName)
										
									

									

										-TLS
                                        
										Specifies the encryption to use for authentication. This parameter accepts "Unencrypted", "StartTLS", and "LDAPS".
										false
										true (ByPropertyName)
										
									

									

										-Server
                                        
										Specifies the server(s) to authenticate against.
Note: IPv6 is not supported for RADIUS authentication.		
										false
										true (ByPropertyName)
										
									

									

										-Server2
                                        
										When using dual factor authentication, use the server parameter to set the address of the RADIUS server(s) and use the 
server2 parameter to set the address of the LDAP server(s).		
										false
										true (ByPropertyName)
										
									

									

										-auth_type
                                        
										Specify the transport protocol used to communicate with the authentication server. Possible values are:
- LDAP-Unencrypted
- LDAP-StartTLS
- LDAP-LDAPS
- RADIUS
- RSA-SECURID
- Certificate
- KCD
- RADIUS and LDAP-Unencrypted
- RADIUS and LDAP-StartTLS
- RADIUS and LDAP-LDAPS		
										false
										true (ByPropertyName)
										
									

									

										-max_failed_auths
                                        
										The maximum number of failed login attempts before the user is locked out.
Range: 0 – 999
0 = Never lock out		
										false
										true (ByPropertyName)
										
									

									

										-reset_fail_tout
                                        
										The time that must elapse before the max_failed_auths counter is reset to 0. This must be less than the unblocktout value. 
This parameter is only relevant if the max_failed_auths parameter is set to a value greater than 0.
Range: 60-86400		
										false
										true (ByPropertyName)
										
									

									

										-unblock_tout
                                        
										The timeout in seconds before a blocked account is automatically unblocked again. This must be greater than the 
reset_fail_tout parameter value.
Range: 60-86400		
										false
										true (ByPropertyName)
										
									

									

										-logon_fmt
                                        
										Specify the logon string format used to authenticate to the LDAP/RADIUS server.
The Username%20only value is only available if the auth_type is set to a RADIUS or RSA-SecurID protocol. The Username value 
is not available if the auth_type is set to RADIUS or a RADIUS and LDAP protocol.		
										false
										true (ByPropertyName)
										
									

									

										-logon_fmt2
                                        
										Specify the logon string format used to authenticate to the server.
										false
										true (ByPropertyName)
										
									

									

										-logon_domain
                                        
										The login domain to be used. This is also used with the logon format to construct the normalized username, for example:
- Principalname: <username>@<domain>
- Username: <domain>\<username>		
										false
										true (ByPropertyName)
										
									

									

										-sess_tout_type
                                        stt
										Specify the type of session timeout to be used:
- idle time
- max duration		
										false
										true (ByPropertyName)
										
									

									

										-sess_tout_idle_pub
                                        stipub
										The session idle timeout value in seconds. This value is used in a public environment.
Range: 60-68400		
										false
										true (ByPropertyName)
										
									

									

										-sess_tout_duration_pub
                                        stdpub
										The maximum duration timeout value for the session in seconds. This value is used in a public environment.
Range: 60-86400		
										false
										true (ByPropertyName)
										
									

									

										-sess_tout_idle_priv
                                        stipriv
										The session idle timeout value in seconds. This value is used in a private environment.
Range: 60-68400		
										false
										true (ByPropertyName)
										
									

									

										-sess_tout_duration_priv
                                        stdpriv
										The maximum duration timeout value for the session in seconds. This value is used in a private environment.
Range: 60-86400		
										false
										true (ByPropertyName)
										
									

									

										-testuser
                                        
										The username that will be used to check the authentication server(s), if you are not using an LDAP endpoint.
Note: If the testuser string contains a /, it must be escaped using //.		
										false
										true (ByPropertyName)
										
									

									

										-testpass
                                        
										The password of the user that will be used to check the authentication server(s), if you are not using an LDAP endpoint.
										false
										true (ByPropertyName)
										
									

									

										-ldapephc
                                        
										Enable this parameter to use the LDAP endpoint admin username and password for the health check.
Range:
0 - Disabled
1 - Enabled		
										false
										false
										
									

									

										-radius_send_nas_id
                                        
										If this parameter is disabled (default), a Network Access Server (NAS) identifier is not sent to the RADIUS server. If it 
is enabled, a NAS identifier string is sent to the RADIUS server. By default, this is the hostname. Alternatively, if a 
value is specified in the radius_nas_id parameter, this value is used as the NAS identifier. If the NAS identifier cannot 
be added, the RADIUS access request is still processed. This field is only available if the auth_type is set to a RADIUS 
option.		
										false
										false
										
									

									

										-radius_nas_id
                                        
										If the radius_send_nas_id parameter is enabled, the radius_nas_id parameter is relevant. When specified, this value is used 
as the NASidentifier. Otherwise, the hostname is used as the NAS identifier. If the NAS identifier cannot be added, the 
RADIUS access request is still processed.
This parameter is only relevant if the auth_type is set to a RADIUS option and the radius_send_nas_id parameter is enabled.		
										false
										false
										
									

									

										-radius_shared_secret
                                        Secret
										The shared secret to be used between the radius server and the LoadMaster.
										false
										true (ByPropertyName)
										
									

									

										-kerberos_domain
                                        KerberosDomain
										The name of the Kerberos realm.
										false
										true (ByPropertyName)
										
									

									

										-kerberos_kdc
                                        SKerberosKDC
										The name of the Kerberos Key Distribution Center (KDC).
										false
										true (ByPropertyName)
										
									

									

										-kcd_username
                                        KCDUsername
										The username of the Kerberos trusted user.
										false
										true (ByPropertyName)
										
									

									

										-kcd_password
                                        KCDPassword
										The password of the Kerberos trusted user.
										false
										true (ByPropertyName)
										
									

									

										-server_side
                                        ServerSide
										Specify if this is an outbound KCD SSO domain or not.
y – KCD
n – Not KCD		
										false
										true (ByPropertyName)
										
									

									

										-cert_check_asi
                                        CertCheck
										This option is only available when the authtype is set to Certificate. When this option is enabled - in addition to 
checking the validity of the client certificate, the client certificate will also be checked against the 
altSecurityIdentities (ASI) attribute of the user on the Active Directory.		
										false
										true (ByPropertyName)
										
									

									

										-cert_check_cn
                                        CertCheckCn
										Enabling this parameter allows a fallback to check the Common Name (CN) in the certificate when the SAN is not available.
										false
										true (ByPropertyName)
										
									

									

										-Logon_Transcode
                                        LogonTranscode
										Enable or disable the transcode of logon credentials from ISO-8859-1 to UTF-8, when required.
0 - Disable
1 - Enable		
										false
										true (ByPropertyName)
										
									

									

										-ldap_endpoint
                                        LdapEndpoint
										Specify the name of an existing LDAP endpoint to use.
										false
										true (ByPropertyName)
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-DomainObject
                                        
										Accepts a custom object that has the Domain, TLS, and Server properties to add to the load balancer. Can be used to import 
a CSV file of entries to the load balancer.		
										false
										true (ByValue, ByPropertyName)
										
									

									

										-ldap_admin
                                        
										The LDAP administrator username.
This is only relevant when the authtype is set to Certificate.		
										false
										true (ByValue, ByPropertyName)
										
									

									

										-ldap_password
                                        
										The LDAP administrator password.
This is only relevant when the authtype is set to Certificate.		
										false
										true (ByValue, ByPropertyName)
										
									

									

										-logonfmt
                                        
										Specify the logon string format used to authenticate to the server. Possible values are:
- Notspecified
- Principalname
- Username
- Usernameonly
The Username value is not available if the auth_type is set to RADIUS or a RADIUS and LDAP protocol.		
										false
										true (ByValue, ByPropertyName)
										
									

									

										-logonfmt2
                                        
										Specify the logon string format used to authenticate to the server.
- Notspecified
- Principalname
- Username		
										false
										true (ByValue, ByPropertyName)
										
									

								
							

						
				
						

                            

                                
 Note 

                            

							
You can only use one login method - either certificate or credential. You cannot use both.

						

                        

                            
 Examples 

                        

						

                            

							    Example

Set-SSODomain -server 10.154.45.22 -Domain example3.com

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.
Param........: @{Id=9; Name=EXAMPLE2.COM; server=10.154.45.22; testuser=; ldap_version=3; server_side=0; 
auth_type=RSA-SECURID; logon_fmt=Principalname;
 logon_fmt2=Principalname; logon_transcode=1; logon_domain=; idp_entity_id=; idp_sso_url=; idp_logoff_url=; idp_cert=; 
sp_entity_id=; sp_cert=UseSelfSig
ned; kerberos_domain=; kerberos_kdc=; kcd_username=; max_failed_auths=0; reset_fail_tout=60; unblock_tout=1800; 
sess_tout_type=idle time; sess_tout_idle
_pub=900; sess_tout_duration_pub=1800; sess_tout_idle_priv=900; sess_tout_duration_priv=28800; cert_check_asi=0; 
cert_check_cn=0}
Id                      : 9
Name                    : EXAMPLE2.COM
server                  : 10.154.45.22
testuser                : 
ldap_version            : 3
server_side             : 0
auth_type               : RSA-SECURID
logon_fmt               : Principalname
logon_fmt2              : Principalname
logon_transcode         : 1
logon_domain            : 
idp_entity_id           : 
idp_sso_url             : 
idp_logoff_url          : 
idp_cert                : 
sp_entity_id            : 
sp_cert                 : UseSelfSigned
kerberos_domain         : 
kerberos_kdc            : 
kcd_username            : 
max_failed_auths        : 0
reset_fail_tout         : 60
unblock_tout            : 1800
sess_tout_type          : idle time
sess_tout_idle_pub      : 900
sess_tout_duration_pub  : 1800
sess_tout_idle_priv     : 900
sess_tout_duration_priv : 28800
cert_check_asi          : 0
cert_check_cn           : 0

                            

						

                        
Top of page
				

				

					

						
 Set-SSODomainUnlockUser 

						
Allows you to unblock users who are currently blocked from accessing the SSO domain.

						
Allows you to unblock users who are currently blocked from accessing the SSO domain.

					

                        

                        
 Syntax 

                        

						

                            


Set-SSODomainUnlockUser -Domain <String> -Users <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Set-SSODomainUnlockUser -Domain <String> -Users <String> [-LoadBalancer <String>] [-LBPort <Int32>] 
[-CertificateStoreLocation <String>] [-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable 
<String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-Domain
                                        Name
										The name of the SSO domain.
										true
										true (ByValue)
										
									

									

										-Users
                                        
										The username of the user to be unblocked.
										true
										true (ByValue)
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Set-SSODomainUnlockUser -Domain example2.com -Users test

							    
Example Output:
Return Code..: 200
Response.....: Command successfully executed.
Data field...: 
UnlockedUsers
-------------
@{user=test}

                            

						

                        
Top of page
				

				

					

						
 Set-SyslogOption 

						
WARNING: This function is deprecated. Use the following command instead:
Set-LogSyslogConfiguration

						
WARNING: This function is deprecated. Use the following command instead:
Set-LogSyslogConfiguration

					

                        

                        
 Syntax 

                        

						

                            


Set-SyslogOption [-SyslogCritical <String>] [-SyslogEmergency <String>] [-SyslogError <String>] [-SyslogInfo <String>] 
[-SyslogNotice <String>] [-SyslogWarn <String>] [-SyslogPort <UInt16>] [-LoadBalancer <String>] [-LBPort <Int32>] 
[-Credential <Object>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Set-SyslogOption [-SyslogCritical <String>] [-SyslogEmergency <String>] [-SyslogError <String>] [-SyslogInfo <String>] 
[-SyslogNotice <String>] [-SyslogWarn <String>] [-SyslogPort <UInt16>] [-LoadBalancer <String>] [-LBPort <Int32>] 
[-CertificateStoreLocation <String>] [-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable 
<String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-SyslogCritical
                                        
										
										false
										false
										
									

									

										-SyslogEmergency
                                        
										
										false
										false
										
									

									

										-SyslogError
                                        
										
										false
										false
										
									

									

										-SyslogInfo
                                        
										
										false
										false
										
									

									

										-SyslogNotice
                                        
										
										false
										false
										
									

									

										-SyslogWarn
                                        
										
										false
										false
										
									

									

										-SyslogPort
                                        
										
										false
										false
										
									

									

										-LoadBalancer
                                        
										
										false
										false
										
									

									

										-LBPort
                                        
										
										false
										false
										
									

									

										-Credential
                                        
										
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										
										false
										false
										
									

									

										-SubjectCN
                                        
										
										false
										false
										
									

								
							

						
				
				

				

					

						
 Set-TlsCipherSet 

						
Create or modify a custom cipher set.

						
Updates an existing custom cipher set or creates a new custom cipher set. If the name of an existing custom cipher set is 
used, that cipher set will be updated. If a new name is used, a new cipher set will be created.

					

                        

                        
 Syntax 

                        

						

                            


Set-TlsCipherSet -Name <String> -Value <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Set-TlsCipherSet -Name <String> -Value <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation 
<String>] [-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-Name
                                        
										The name of the custom cipher set.
										true
										false
										
									

									

										-Value
                                        
										A colon (:) separated list of ciphers to assign to the set.
										true
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
						

                            

                                
 Note 

                            

							
If the name of an existing custom cipher set is specified, that cipher set will be updated. If a new name is used, a 
    new cipher set will be created.

						

                        

                            
 Examples 

                        

						

                            

							    Example

Set-TlsCipherSet -Name ExampleCipherSet -Value ECDHE-RSA-AES256-SHA384:ECDHE-ECDSA-AES256-SHA384:ECDHE-RSA-AES256-SHA

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.

                            

						

                        
Top of page
				

				

					

						
 Set-TlsHSM 

						
WARNING: This function is not available. The Hardware Security Module (HSM) feature has been removed from the LoadMaster.

						
This command will not work on LoadMaster versions 7.2.46.0 and newer. If you want to use PowerShell to configure HSM on an 
older LoadMaster 
version, use the PowerShell module corresponding to that version, for example PowerShell-7.2.45.

					

                        

                        
 Syntax 

                        

						

                            


Set-TlsHSM [-Sethsm <String>] [-Safeaddr <String>] [-Clpass <String>] [-Enable <Boolean>] [-Cavhsmaddr <String>] 
[-Cavhsmpasswd <String>] [-Cavhsmuser <String>] [-Cavhsmenable <Boolean>] [-LoadBalancer <String>] [-LBPort <Int32>] 
[-Credential <Object>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Set-TlsHSM [-Sethsm <String>] [-Safeaddr <String>] [-Clpass <String>] [-Enable <Boolean>] [-Cavhsmaddr <String>] 
[-Cavhsmpasswd <String>] [-Cavhsmuser <String>] [-Cavhsmenable <Boolean>] [-LoadBalancer <String>] [-LBPort <Int32>] 
[-CertificateStoreLocation <String>] [-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable 
<String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-Sethsm
                                        
										To set the HSM sub-system to Safenet Luna HSM use LunaCA3. To set the HSM sub-system to Cavium HSM use cavhsm. These 
parameters are case sensitive.		
										false
										false
										
									

									

										-Safeaddr
                                        
										Specify the address of the Safenet HSM unit to be used.
										false
										false
										
									

									

										-Clpass
                                        
										Specify the password for the partition on the HSM so that the LoadMaster can access the HSM.
										false
										false
										
									

									

										-Enable
                                        
										Enable or disable Safenet HSM:
0 – Disabled
1 – Enabled		
										false
										false
										
									

									

										-Cavhsmaddr
                                        
										Specify the address of the Cavium HSM unit to be used.
										false
										false
										
									

									

										-Cavhsmpasswd
                                        
										The password for the HSM partition. The HSM partition password would have been set on the HSM when originally configuring 
the partition. For further information, please consult the HSM vendor documentation.		
										false
										false
										
									

									

										-Cavhsmuser
                                        
										The username for the HSM partition.
										false
										false
										
									

									

										-Cavhsmenable
                                        
										Enable Cavium HSM:
0 - Disable
1 - Enable		
										false
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
						

                            

                                
 Note 

                            

							
Starting the HSM may take some time.
    
    Disabling the HSM means the LoadMaster is unable to create new SSL (HTTPS) connections and immediately drops existing 
    connections until another HSM is added or the certificate configuration is changed.
    
    It is strongly recommended to only change the HSM configuration when there are no active SSL connections.

						

                        

                            
 Examples 

                        

						

                            

							    Example

Set-TlsHSM -Cavhsmaddr 10.154.22.44

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.
Data field...: @{engine=cavhsm; addr=10.154.22.44; user=ExampleUser; enable=0}
cavhsm 10.154.22.44  ExampleUser 0

                            

						

                        
Top of page
				

				

					

						
 Set-VirtualService 

						
WARNING: This function is deprecated. Use the following command instead:
Set-AdcVirtualService

						
WARNING: This function is deprecated. Use the following command instead:
Set-AdcVirtualService

					

                        

                        
 Syntax 

                        

						

                            


Set-VirtualService [-VirtualService <String>] [-VSPort <Int32>] [-VSProtocol <String>] [-VSIndex <Int32>] [-AddVia <Int16>] 
[-Cache <Boolean>] [-CertFile <String>] [-CheckType <String>] [-CheckHost <String>] [-CheckPattern <String>] [-CheckUrl 
<String>] [-CheckHeaders <String>] [-LdapEndpoint <String>] [-MatchLen <String>] [-CheckUse1_1 <Int32>] [-CheckPort 
<Int32>] [-EnhancedHealthChecks <Boolean>] [-RsMinimum <Int32>] [-ClientCert <Int16>] [-Compress <Boolean>] [-Cookie 
<String>] [-CachePercent <Int16>] [-DefaultGW <String>] [-Enable <Boolean>] [-ErrorCode <String>] [-ErrorUrl <String>] 
[-PortFollow <Int32>] [-ForceL7 <Boolean>] [-Idletime <Int32>] [-LocalBindAddresses <String[]>] [-VSType <String>] 
[-Nickname <String>] [-Persist <String>] [-PersistTimeout <Int32>] [-QueryTag <String>] [-CipherSet <String>] 
[-SSLReencrypt <Boolean>] [-SSLReverse <Boolean>] [-SSLRewrite <String>] [-ReverseSNIHostname <String>] [-Schedule 
<String>] [-ServerInit <Int16>] [-SSLAcceleration <Boolean>] [-StandByAddr <String>] [-StandByPort <String>] 
[-TransactionLimit <Int32>] [-Transparent <Boolean>] [-SubnetOriginating <Boolean>] [-UseforSnat <Boolean>] [-QoS <String>] 
[-CheckUseGet <Int32>] [-Verify <Int16>] [-ExtraHdrKey <String>] [-ExtraHdrValue <String>] [-AllowedHosts <String>] 
[-AllowedDirectories <String>] [-AllowedGroups <String>] [-GroupSIDs <String>] [-IncludeNestedGroups <Boolean>] 
[-DisplayPubPriv <Boolean>] [-DisablePasswordForm <Boolean>] [-Domain <String>] [-AltDomains <String>] [-Logoff <String>] 
[-ESPLogs <Int16>] [-SMTPAllowedDomains <String>] [-ESPEnabled <Boolean>] [-UserPwdChangeUrl <String>] [-UserPwdChangeMsg 
<String>] [-InputAuthMode <Int16>] [-OutputAuthMode <Int16>] [-StartTLSMode <Int16>] [-ExtraPorts <String>] [-AltAddress 
<String>] [-MultiConnect <Boolean>] [-SingleSignOnDir <String>] [-OCSPVerify <String>] [-FollowVSID <Int32>] [-TlsType 
<Boolean>] [-CheckPostData <String>] [-CheckCodes <String>] [-PreProcPrecedence <String>] [-PreProcPrecedencePos <Int16>] 
[-RequestPrecedence <String>] [-RequestPrecedencePos <Int16>] [-ResponsePrecedence <String>] [-ResponsePrecedencePos 
<Int16>] [-RsRulePrecedence <String>] [-RsRulePrecedencePos <Int16>] [-NeedHostName <Boolean>] [-CopyHdrFrom <String>] 
[-CopyHdrTo <String>] [-ServerFbaPath <String>] [-ServerFbaPost <String>] [-Intercept <Boolean>] [-AllowHTTP2 <Boolean>] 
[-InterceptOpts <String>] [-InterceptRules <String>] [-AlertThreshold <Int32>] [-LoadBalancer <String>] [-LBPort <Int32>] 
[-Credential <Object>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Set-VirtualService [-VirtualService <String>] [-VSPort <Int32>] [-VSProtocol <String>] [-VSIndex <Int32>] [-AddVia <Int16>] 
[-Cache <Boolean>] [-CertFile <String>] [-CheckType <String>] [-CheckHost <String>] [-CheckPattern <String>] [-CheckUrl 
<String>] [-CheckHeaders <String>] [-LdapEndpoint <String>] [-MatchLen <String>] [-CheckUse1_1 <Int32>] [-CheckPort 
<Int32>] [-EnhancedHealthChecks <Boolean>] [-RsMinimum <Int32>] [-ClientCert <Int16>] [-Compress <Boolean>] [-Cookie 
<String>] [-CachePercent <Int16>] [-DefaultGW <String>] [-Enable <Boolean>] [-ErrorCode <String>] [-ErrorUrl <String>] 
[-PortFollow <Int32>] [-ForceL7 <Boolean>] [-Idletime <Int32>] [-LocalBindAddresses <String[]>] [-VSType <String>] 
[-Nickname <String>] [-Persist <String>] [-PersistTimeout <Int32>] [-QueryTag <String>] [-CipherSet <String>] 
[-SSLReencrypt <Boolean>] [-SSLReverse <Boolean>] [-SSLRewrite <String>] [-ReverseSNIHostname <String>] [-Schedule 
<String>] [-ServerInit <Int16>] [-SSLAcceleration <Boolean>] [-StandByAddr <String>] [-StandByPort <String>] 
[-TransactionLimit <Int32>] [-Transparent <Boolean>] [-SubnetOriginating <Boolean>] [-UseforSnat <Boolean>] [-QoS <String>] 
[-CheckUseGet <Int32>] [-Verify <Int16>] [-ExtraHdrKey <String>] [-ExtraHdrValue <String>] [-AllowedHosts <String>] 
[-AllowedDirectories <String>] [-AllowedGroups <String>] [-GroupSIDs <String>] [-IncludeNestedGroups <Boolean>] 
[-DisplayPubPriv <Boolean>] [-DisablePasswordForm <Boolean>] [-Domain <String>] [-AltDomains <String>] [-Logoff <String>] 
[-ESPLogs <Int16>] [-SMTPAllowedDomains <String>] [-ESPEnabled <Boolean>] [-UserPwdChangeUrl <String>] [-UserPwdChangeMsg 
<String>] [-InputAuthMode <Int16>] [-OutputAuthMode <Int16>] [-StartTLSMode <Int16>] [-ExtraPorts <String>] [-AltAddress 
<String>] [-MultiConnect <Boolean>] [-SingleSignOnDir <String>] [-OCSPVerify <String>] [-FollowVSID <Int32>] [-TlsType 
<Boolean>] [-CheckPostData <String>] [-CheckCodes <String>] [-PreProcPrecedence <String>] [-PreProcPrecedencePos <Int16>] 
[-RequestPrecedence <String>] [-RequestPrecedencePos <Int16>] [-ResponsePrecedence <String>] [-ResponsePrecedencePos 
<Int16>] [-RsRulePrecedence <String>] [-RsRulePrecedencePos <Int16>] [-NeedHostName <Boolean>] [-CopyHdrFrom <String>] 
[-CopyHdrTo <String>] [-ServerFbaPath <String>] [-ServerFbaPost <String>] [-Intercept <Boolean>] [-AllowHTTP2 <Boolean>] 
[-InterceptOpts <String>] [-InterceptRules <String>] [-AlertThreshold <Int32>] [-LoadBalancer <String>] [-LBPort <Int32>] 
[-CertificateStoreLocation <String>] [-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable 
<String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-VirtualService
                                        
										
										false
										false
										
									

									

										-VSPort
                                        
										
										false
										false
										
									

									

										-VSProtocol
                                        
										
										false
										false
										
									

									

										-VSIndex
                                        
										
										false
										false
										
									

									

										-AddVia
                                        
										
										false
										false
										
									

									

										-Cache
                                        
										
										false
										false
										
									

									

										-CertFile
                                        
										
										false
										false
										
									

									

										-CheckType
                                        
										
										false
										false
										
									

									

										-CheckHost
                                        
										
										false
										false
										
									

									

										-CheckPattern
                                        
										
										false
										false
										
									

									

										-CheckUrl
                                        
										
										false
										false
										
									

									

										-CheckHeaders
                                        
										
										false
										false
										
									

									

										-LdapEndpoint
                                        
										
										false
										false
										
									

									

										-MatchLen
                                        
										
										false
										false
										
									

									

										-CheckUse1_1
                                        
										
										false
										false
										
									

									

										-CheckPort
                                        
										
										false
										false
										
									

									

										-EnhancedHealthChecks
                                        
										
										false
										false
										
									

									

										-RsMinimum
                                        
										
										false
										false
										
									

									

										-ClientCert
                                        
										
										false
										false
										
									

									

										-Compress
                                        
										
										false
										false
										
									

									

										-Cookie
                                        
										
										false
										false
										
									

									

										-CachePercent
                                        
										
										false
										false
										
									

									

										-DefaultGW
                                        
										
										false
										false
										
									

									

										-Enable
                                        
										
										false
										false
										
									

									

										-ErrorCode
                                        
										
										false
										false
										
									

									

										-ErrorUrl
                                        
										
										false
										false
										
									

									

										-PortFollow
                                        
										
										false
										false
										
									

									

										-ForceL7
                                        
										
										false
										false
										
									

									

										-Idletime
                                        
										
										false
										false
										
									

									

										-LocalBindAddresses
                                        
										
										false
										false
										
									

									

										-VSType
                                        
										
										false
										false
										
									

									

										-Nickname
                                        
										
										false
										false
										
									

									

										-Persist
                                        
										
										false
										false
										
									

									

										-PersistTimeout
                                        
										
										false
										false
										
									

									

										-QueryTag
                                        
										
										false
										false
										
									

									

										-CipherSet
                                        
										
										false
										false
										
									

									

										-SSLReencrypt
                                        
										
										false
										false
										
									

									

										-SSLReverse
                                        
										
										false
										false
										
									

									

										-SSLRewrite
                                        
										
										false
										false
										
									

									

										-ReverseSNIHostname
                                        
										
										false
										false
										
									

									

										-Schedule
                                        
										
										false
										false
										
									

									

										-ServerInit
                                        
										
										false
										false
										
									

									

										-SSLAcceleration
                                        
										
										false
										false
										
									

									

										-StandByAddr
                                        
										
										false
										false
										
									

									

										-StandByPort
                                        
										
										false
										false
										
									

									

										-TransactionLimit
                                        
										
										false
										false
										
									

									

										-Transparent
                                        
										
										false
										false
										
									

									

										-SubnetOriginating
                                        
										
										false
										false
										
									

									

										-UseforSnat
                                        
										
										false
										false
										
									

									

										-QoS
                                        
										
										false
										false
										
									

									

										-CheckUseGet
                                        
										
										false
										false
										
									

									

										-Verify
                                        
										
										false
										false
										
									

									

										-ExtraHdrKey
                                        
										
										false
										false
										
									

									

										-ExtraHdrValue
                                        
										
										false
										false
										
									

									

										-AllowedHosts
                                        
										
										false
										false
										
									

									

										-AllowedDirectories
                                        
										
										false
										false
										
									

									

										-AllowedGroups
                                        
										
										false
										false
										
									

									

										-GroupSIDs
                                        
										
										false
										false
										
									

									

										-IncludeNestedGroups
                                        
										
										false
										false
										
									

									

										-DisplayPubPriv
                                        
										
										false
										false
										
									

									

										-DisablePasswordForm
                                        
										
										false
										false
										
									

									

										-Domain
                                        
										
										false
										false
										
									

									

										-AltDomains
                                        
										
										false
										false
										
									

									

										-Logoff
                                        
										
										false
										false
										
									

									

										-ESPLogs
                                        
										
										false
										false
										
									

									

										-SMTPAllowedDomains
                                        
										
										false
										false
										
									

									

										-ESPEnabled
                                        
										
										false
										false
										
									

									

										-UserPwdChangeUrl
                                        
										
										false
										false
										
									

									

										-UserPwdChangeMsg
                                        
										
										false
										false
										
									

									

										-InputAuthMode
                                        
										
										false
										false
										
									

									

										-OutputAuthMode
                                        
										
										false
										false
										
									

									

										-StartTLSMode
                                        
										
										false
										false
										
									

									

										-ExtraPorts
                                        
										
										false
										false
										
									

									

										-AltAddress
                                        
										
										false
										false
										
									

									

										-MultiConnect
                                        
										
										false
										false
										
									

									

										-SingleSignOnDir
                                        
										
										false
										false
										
									

									

										-OCSPVerify
                                        
										
										false
										false
										
									

									

										-FollowVSID
                                        
										
										false
										false
										
									

									

										-TlsType
                                        
										
										false
										false
										
									

									

										-CheckPostData
                                        
										
										false
										false
										
									

									

										-CheckCodes
                                        
										
										false
										false
										
									

									

										-PreProcPrecedence
                                        
										
										false
										false
										
									

									

										-PreProcPrecedencePos
                                        
										
										false
										false
										
									

									

										-RequestPrecedence
                                        
										
										false
										false
										
									

									

										-RequestPrecedencePos
                                        
										
										false
										false
										
									

									

										-ResponsePrecedence
                                        
										
										false
										false
										
									

									

										-ResponsePrecedencePos
                                        
										
										false
										false
										
									

									

										-RsRulePrecedence
                                        
										
										false
										false
										
									

									

										-RsRulePrecedencePos
                                        
										
										false
										false
										
									

									

										-NeedHostName
                                        
										
										false
										false
										
									

									

										-CopyHdrFrom
                                        
										
										false
										false
										
									

									

										-CopyHdrTo
                                        
										
										false
										false
										
									

									

										-ServerFbaPath
                                        
										
										false
										false
										
									

									

										-ServerFbaPost
                                        
										
										false
										false
										
									

									

										-Intercept
                                        
										
										false
										false
										
									

									

										-AllowHTTP2
                                        
										
										false
										false
										
									

									

										-InterceptOpts
                                        
										
										false
										false
										
									

									

										-InterceptRules
                                        
										
										false
										false
										
									

									

										-AlertThreshold
                                        
										
										false
										false
										
									

									

										-LoadBalancer
                                        
										
										false
										false
										
									

									

										-LBPort
                                        
										
										false
										false
										
									

									

										-Credential
                                        
										
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										
										false
										false
										
									

									

										-SubjectCN
                                        
										
										false
										false
										
									

								
							

						
				
				

				

					

						
 SetVpnAddrs 

						
WARNING: This function is deprecated. Use the following command instead:
Set-LmVpnAddrs

						
WARNING: This function is deprecated. Use the following command instead:
Set-LmVpnAddrs

					

                        

                        
 Syntax 

                        

						

                            


SetVpnAddrs -Name <String> -LocalIp <String> -LocalSubnets <String> -RemoteIp <String> -RemoteSubnets <String> 
[-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction <ActionPreference>] 
[-InformationVariable <String>] [<CommonParameters>]

SetVpnAddrs -Name <String> -LocalIp <String> -LocalSubnets <String> -RemoteIp <String> -RemoteSubnets <String> 
[-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN <String>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-Name
                                        
										
										true
										false
										
									

									

										-LocalIp
                                        
										
										true
										false
										
									

									

										-LocalSubnets
                                        
										
										true
										false
										
									

									

										-RemoteIp
                                        
										
										true
										false
										
									

									

										-RemoteSubnets
                                        
										
										true
										false
										
									

									

										-LoadBalancer
                                        
										
										false
										false
										
									

									

										-LBPort
                                        
										
										false
										false
										
									

									

										-Credential
                                        
										
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										
										false
										false
										
									

									

										-SubjectCN
                                        
										
										false
										false
										
									

								
							

						
				
				

				

					

						
 SetVpnLocalIp 

						
WARNING: This function is deprecated. Use the following command instead:
Set-LmVpnLocalIp

						
WARNING: This function is deprecated. Use the following command instead:
Set-LmVpnLocalIp

					

                        

                        
 Syntax 

                        

						

                            


SetVpnLocalIp -Name <String> -LocalIp <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

SetVpnLocalIp -Name <String> -LocalIp <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation 
<String>] [-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-Name
                                        
										
										true
										false
										
									

									

										-LocalIp
                                        
										
										true
										false
										
									

									

										-LoadBalancer
                                        
										
										false
										false
										
									

									

										-LBPort
                                        
										
										false
										false
										
									

									

										-Credential
                                        
										
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										
										false
										false
										
									

									

										-SubjectCN
                                        
										
										false
										false
										
									

								
							

						
				
				

				

					

						
 SetVpnLocalSubnets 

						
WARNING: This function is deprecated. Use the following command instead:
Set-LmVpnLocalSubnet

						
WARNING: This function is deprecated. Use the following command instead:
Set-LmVpnLocalSubnet

					

                        

                        
 Syntax 

                        

						

                            


SetVpnLocalSubnets -Name <String> -LocalSubnets <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

SetVpnLocalSubnets -Name <String> -LocalSubnets <String> [-LoadBalancer <String>] [-LBPort <Int32>] 
[-CertificateStoreLocation <String>] [-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable 
<String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-Name
                                        
										
										true
										false
										
									

									

										-LocalSubnets
                                        
										
										true
										false
										
									

									

										-LoadBalancer
                                        
										
										false
										false
										
									

									

										-LBPort
                                        
										
										false
										false
										
									

									

										-Credential
                                        
										
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										
										false
										false
										
									

									

										-SubjectCN
                                        
										
										false
										false
										
									

								
							

						
				
				

				

					

						
 SetVpnPfsDisable 

						
WARNING: This function is deprecated. Use the following command instead:
Set-LmVpnPfsDisable

						
WARNING: This function is deprecated. Use the following command instead:
Set-LmVpnPfsDisable

					

                        

                        
 Syntax 

                        

						

                            


SetVpnPfsDisable -Name <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

SetVpnPfsDisable -Name <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN 
<String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-Name
                                        
										
										true
										false
										
									

									

										-LoadBalancer
                                        
										
										false
										false
										
									

									

										-LBPort
                                        
										
										false
										false
										
									

									

										-Credential
                                        
										
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										
										false
										false
										
									

									

										-SubjectCN
                                        
										
										false
										false
										
									

								
							

						
				
				

				

					

						
 SetVpnPfsEnable 

						
WARNING: This function is deprecated. Use the following command instead:
Set-LmVpnPfsEnable

						
WARNING: This function is deprecated. Use the following command instead:
Set-LmVpnPfsEnable

					

                        

                        
 Syntax 

                        

						

                            


SetVpnPfsEnable -Name <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

SetVpnPfsEnable -Name <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN 
<String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-Name
                                        
										
										true
										false
										
									

									

										-LoadBalancer
                                        
										
										false
										false
										
									

									

										-LBPort
                                        
										
										false
										false
										
									

									

										-Credential
                                        
										
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										
										false
										false
										
									

									

										-SubjectCN
                                        
										
										false
										false
										
									

								
							

						
				
				

				

					

						
 SetVpnRemoteIp 

						
WARNING: This function is deprecated. Use the following command instead:
Set-LmVpnRemoteIp

						
WARNING: This function is deprecated. Use the following command instead:
Set-LmVpnRemoteIp

					

                        

                        
 Syntax 

                        

						

                            


SetVpnRemoteIp -Name <String> -RemoteIp <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

SetVpnRemoteIp -Name <String> -RemoteIp <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation 
<String>] [-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-Name
                                        
										
										true
										false
										
									

									

										-RemoteIp
                                        
										
										true
										false
										
									

									

										-LoadBalancer
                                        
										
										false
										false
										
									

									

										-LBPort
                                        
										
										false
										false
										
									

									

										-Credential
                                        
										
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										
										false
										false
										
									

									

										-SubjectCN
                                        
										
										false
										false
										
									

								
							

						
				
				

				

					

						
 SetVpnRemoteSubnets 

						
WARNING: This function is deprecated. Use the following command instead:
Set-LmVpnRemoteSubnet

						
WARNING: This function is deprecated. Use the following command instead:
Set-LmVpnRemoteSubnet

					

                        

                        
 Syntax 

                        

						

                            


SetVpnRemoteSubnets -Name <String> -RemoteSubnets <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential 
<Object>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

SetVpnRemoteSubnets -Name <String> -RemoteSubnets <String> [-LoadBalancer <String>] [-LBPort <Int32>] 
[-CertificateStoreLocation <String>] [-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable 
<String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-Name
                                        
										
										true
										false
										
									

									

										-RemoteSubnets
                                        
										
										true
										false
										
									

									

										-LoadBalancer
                                        
										
										false
										false
										
									

									

										-LBPort
                                        
										
										false
										false
										
									

									

										-Credential
                                        
										
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										
										false
										false
										
									

									

										-SubjectCN
                                        
										
										false
										false
										
									

								
							

						
				
				

				

					

						
 SetVpnSecret 

						
WARNING: This function is deprecated. Use the following command instead:
Set-LmVpnSecret

						
WARNING: This function is deprecated. Use the following command instead:
Set-LmVpnSecret

					

                        

                        
 Syntax 

                        

						

                            


SetVpnSecret -Name <String> -LocalId <String> -RemoteId <String> -Key <String> [-LoadBalancer <String>] [-LBPort <Int32>] 
[-Credential <Object>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

SetVpnSecret -Name <String> -LocalId <String> -RemoteId <String> -Key <String> [-LoadBalancer <String>] [-LBPort <Int32>] 
[-CertificateStoreLocation <String>] [-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable 
<String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-Name
                                        
										
										true
										false
										
									

									

										-LocalId
                                        
										
										true
										false
										
									

									

										-RemoteId
                                        
										
										true
										false
										
									

									

										-Key
                                        
										
										true
										false
										
									

									

										-LoadBalancer
                                        
										
										false
										false
										
									

									

										-LBPort
                                        
										
										false
										false
										
									

									

										-Credential
                                        
										
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										
										false
										false
										
									

									

										-SubjectCN
                                        
										
										false
										false
										
									

								
							

						
				
				

				

					

						
 Set-WafLogFormat 

						
Configure the format of the WAF logs.

						
The WAF logs can either be in JSON or native format.

					

                        

                        
 Syntax 

                        

						

                            


Set-WafLogFormat -LogFormat <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Set-WafLogFormat -LogFormat <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] 
[-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-LogFormat
                                        
										Specify the format of the WAF log. This can be either in JSON or native format. Valid values are:


- json
 - native		
										true
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Set-WafLogFormat -LogFormat json

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.

                            

						

                        
Top of page
				

				

					

						
 Set-WafRulesAutoUpdateConfiguration 

						
Configure the Web Application Firewall (WAF) auto-update settings.

						
This command can be used to set the WAF auto-update settings.

					

                        

                        
 Syntax 

                        

						

                            


Set-WafRulesAutoUpdateConfiguration -DatabaseAutoUpdate <SwitchParameter> [-LoadBalancer <String>] [-LBPort <Int32>] 
[-Credential <Object>] [-CertificateStoreLocation <String>] [-SubjectCN <String>] [-InformationAction <ActionPreference>] 
[-InformationVariable <String>] [<CommonParameters>]

Set-WafRulesAutoUpdateConfiguration [-DatabaseAutoInstall <SwitchParameter>] [-DatabaseInstallTimeHour <Int32>] 
[-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-CertificateStoreLocation <String>] [-SubjectCN 
<String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-DatabaseAutoUpdate
                                        
										Enable or disable the automatic downloading of updates to the commercial WAF rule files. When this option is enabled, 
updated rules are downloaded on a daily basis from Kemp. The installation time for these rule updates is 4am.		
										true
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-DatabaseAutoInstall
                                        
										Enable or disable the automatic installation of updated commercial rule files.
										false
										false
										
									

									

										-DatabaseInstallTimeHour
                                        
										Set the time of day that the commercial rule files will be automatically installed. The hour is the hour value from the 
24-hour clock (0-23), for example 13 is 1pm. The range is 0-23. Minutes cannot be specified.		
										false
										false
										
									

								
							

						
				
						

                            

                                
 Note 

                            

							
You can only use one login method - either certificate or credential. You cannot use both.

						

                        

                            
 Examples 

                        

						

                            

							    Example

Set-WafRulesAutoUpdateConfiguration -DatabaseInstallTimeHour 3

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed; Data=}
Return Code..: 200
Response.....: Command successfully executed

                            

						

                        
Top of page
				

				

					

						
 Set-WUIAuth 

						
WARNING: This function is deprecated. Use the following command instead:
Set-SecWuiAuthentication

						
WARNING: This function is deprecated. Use the following command instead:
Set-SecWuiAuthentication

					

                        

                        
 Syntax 

                        

						

                            


Set-WUIAuth [-RADIUSServer <String>] [-RADIUSPort <Int64>] [-RADIUSSecret <String>] [-RADIUSBackupServer <String>] 
[-RADIUSBackupPort <Int64>] [-RADIUSBackupSecret <String>] [-RADIUSRevalidateInterval <Int32>] [-WuiLdapEp <String>] 
[-SessionLocalAuth <Boolean>] [-SessionAuthMode <Int16>] [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Set-WUIAuth [-RADIUSServer <String>] [-RADIUSPort <Int64>] [-RADIUSSecret <String>] [-RADIUSBackupServer <String>] 
[-RADIUSBackupPort <Int64>] [-RADIUSBackupSecret <String>] [-RADIUSRevalidateInterval <Int32>] [-WuiLdapEp <String>] 
[-SessionLocalAuth <Boolean>] [-SessionAuthMode <Int16>] [-LoadBalancer <String>] [-LBPort <Int32>] 
[-CertificateStoreLocation <String>] [-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable 
<String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-RADIUSServer
                                        
										
										false
										false
										
									

									

										-RADIUSPort
                                        
										
										false
										false
										
									

									

										-RADIUSSecret
                                        
										
										false
										false
										
									

									

										-RADIUSBackupServer
                                        
										
										false
										false
										
									

									

										-RADIUSBackupPort
                                        
										
										false
										false
										
									

									

										-RADIUSBackupSecret
                                        
										
										false
										false
										
									

									

										-RADIUSRevalidateInterval
                                        
										
										false
										false
										
									

									

										-WuiLdapEp
                                        
										
										false
										false
										
									

									

										-SessionLocalAuth
                                        
										
										false
										false
										
									

									

										-SessionAuthMode
                                        
										
										false
										false
										
									

									

										-LoadBalancer
                                        
										
										false
										false
										
									

									

										-LBPort
                                        
										
										false
										false
										
									

									

										-Credential
                                        
										
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										
										false
										false
										
									

									

										-SubjectCN
                                        
										
										false
										false
										
									

								
							

						
				
				

				

					

						
 Set-WUISetting 

						
WARNING: This function is deprecated. Use the following command instead:
Set-SecAdminWuiConfiguration

						
WARNING: This function is deprecated. Use the following command instead:
Set-SecAdminWuiConfiguration

					

                        

                        
 Syntax 

                        

						

                            


Set-WUISetting [-WUITLSProtocols <Int32>] [-WUICipherset <String>] [-sessioncontrol <Boolean>] [-sessionbasicauth 
<Boolean>] [-sessionmaxfailattempts <Int16>] [-sessionidletime <Int32>] [-sessionconcurrent <Int16>] [-wuipreauth <String>] 
[-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction <ActionPreference>] 
[-InformationVariable <String>] [<CommonParameters>]

Set-WUISetting [-WUITLSProtocols <Int32>] [-WUICipherset <String>] [-sessioncontrol <Boolean>] [-sessionbasicauth 
<Boolean>] [-sessionmaxfailattempts <Int16>] [-sessionidletime <Int32>] [-sessionconcurrent <Int16>] [-wuipreauth <String>] 
[-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN <String>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-WUITLSProtocols
                                        
										
										false
										false
										
									

									

										-WUICipherset
                                        
										
										false
										false
										
									

									

										-sessioncontrol
                                        
										
										false
										false
										
									

									

										-sessionbasicauth
                                        
										
										false
										false
										
									

									

										-sessionmaxfailattempts
                                        
										
										false
										false
										
									

									

										-sessionidletime
                                        
										
										false
										false
										
									

									

										-sessionconcurrent
                                        
										
										false
										false
										
									

									

										-wuipreauth
                                        
										
										false
										false
										
									

									

										-LoadBalancer
                                        
										
										false
										false
										
									

									

										-LBPort
                                        
										
										false
										false
										
									

									

										-Credential
                                        
										
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										
										false
										false
										
									

									

										-SubjectCN
                                        
										
										false
										false
										
									

								
							

						
				
				

				

					

						
 ShowCluster 

						
WARNING: This function is deprecated. Use the following command instead:
Get-GeoCluster

						
WARNING: This function is deprecated. Use the following command instead:
Get-GeoCluster

					

                        

                        
 Syntax 

                        

						

                            


ShowCluster [-ClusterIp <String>] [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

ShowCluster [-ClusterIp <String>] [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] 
[-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-ClusterIp
                                        
										
										false
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										
										false
										false
										
									

									

										-SubjectCN
                                        
										
										false
										false
										
									

									

										-IP
                                        
										The IP address of the cluster.
										true
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

ShowCluster –IP <IPAddress>

							    
Example Output:
Enable            : Y
LocationLatitude  : 0.00000000
Type              : localLM
LocationLongitude : 0.00000000
ClusterVSAddress  : 
Checker           : none
Name              : local_Cluster
Index             : 1
Status            : Up
CheckerPort       : 0
IPAddress         : 10.11.0.105

                            

						

                        
Top of page
				

				

					

						
 ShowIP 

						
WARNING: This function is deprecated. Use the following command instead:
Get-GeoIpRange

						
WARNING: This function is deprecated. Use the following command instead:
Get-GeoIpRange

					

                        

                        
 Syntax 

                        

						

                            


ShowIP [-IP <String>] [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

ShowIP [-IP <String>] [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN <String>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-IP
                                        
										IP address of the IP range.
										false
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										
										false
										false
										
									

									

										-SubjectCN
                                        
										
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

ShowIP –IP <IPAddress>

							    
Example Output:
countrycode    : IE
Ip             : 10.11.0.65
Used           : Y
IsCustom       : N
Mask           : 24
Index          : 2
CustomLocation : 0
IPAddress      : 10.11.0.65

                            

						

                        
Top of page
				

				

					

						
 StartIkeDaemon 

						
WARNING: This function is deprecated. Use the following command instead:
Start-LmVpnIkeDaemon

						
WARNING: This function is deprecated. Use the following command instead:
Start-LmVpnIkeDaemon

					

                        

                        
 Syntax 

                        

						

                            


StartIkeDaemon [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction <ActionPreference>] 
[-InformationVariable <String>] [<CommonParameters>]

StartIkeDaemon [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN <String>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-LoadBalancer
                                        
										
										false
										false
										
									

									

										-LBPort
                                        
										
										false
										false
										
									

									

										-Credential
                                        
										
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										
										false
										false
										
									

									

										-SubjectCN
                                        
										
										false
										false
										
									

								
							

						
				
				

				

					

						
 Start-LmVpnConnection 

						
Start the Virtual Private Network (VPN)

						
This command allows you to start the connection of specified VPN.

					

                        

                        
 Syntax 

                        

						

                            


Start-LmVpnConnection -Name <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Start-LmVpnConnection -Name <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] 
[-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-Name
                                        
										The name of the VPN.
										true
										false
										
									

									

										-LoadBalancer
                                        
										The IP address of the Kemp LoadMaster that you are directing the command to. This can be set globally by using the 
Initialize-LoadBalancer command, but can be overridden on each individual command by using this parameter.		
										false
										false
										
									

									

										-LBPort
                                        
										The port of the load balancer.
										false
										false
										
									

									

										-Credential
                                        
										Specifies a user account that has permission to administer the load balancer. You can either enter a username for the load 
balancer or provide a PSCredential object, such as an object that is returned by the Get-Credential cmdlet. When you type a 
username, you are prompted for a password.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Start-LmVpnConnection -Name ExampleVPN

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.

                            

						

                        
Top of page
				

				

					

						
 Start-LmVpnIkeDaemon 

						
Starts the Internet Key Exchange (IKE) daemon.

						
Run this command to start the IKE daemon.

					

                        

                        
 Syntax 

                        

						

                            


Start-LmVpnIkeDaemon [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Start-LmVpnIkeDaemon [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN <String>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Start-LmVpnIkeDaemon

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.

                            

						

                        
Top of page
				

				

					

						
 StartVpnConnection 

						
WARNING: This function is deprecated. Use the following command instead:
Start-LmVpnConnection

						
WARNING: This function is deprecated. Use the following command instead:
Start-LmVpnConnection

					

                        

                        
 Syntax 

                        

						

                            


StartVpnConnection -Name <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

StartVpnConnection -Name <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] 
[-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-Name
                                        
										
										true
										false
										
									

									

										-LoadBalancer
                                        
										
										false
										false
										
									

									

										-LBPort
                                        
										
										false
										false
										
									

									

										-Credential
                                        
										
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										
										false
										false
										
									

									

										-SubjectCN
                                        
										
										false
										false
										
									

								
							

						
				
				

				

					

						
 StatusIkeDaemon 

						
WARNING: This function is deprecated. Use the following command instead:
Get-LmVpnIkeDaemonStatus

						
WARNING: This function is deprecated. Use the following command instead:
Get-LmVpnIkeDaemonStatus

					

                        

                        
 Syntax 

                        

						

                            


StatusIkeDaemon [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction <ActionPreference>] 
[-InformationVariable <String>] [<CommonParameters>]

StatusIkeDaemon [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN <String>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-LoadBalancer
                                        
										
										false
										false
										
									

									

										-LBPort
                                        
										
										false
										false
										
									

									

										-Credential
                                        
										
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										
										false
										false
										
									

									

										-SubjectCN
                                        
										
										false
										false
										
									

								
							

						
				
				

				

					

						
 Stop-AslInstance 

						
If the Activation Server functionality was used to license the LoadMaster, this command can be used to deactivate the client LoadMaster license.

						
Kemp strongly recommends deregistering a LoadMaster using the Kemp 360 Central User Interface (UI) or the Kemp 360 Central 
API, rather than the LoadMaster ones. Deregistering a LoadMaster from the LoadMaster UI can lead to the LoadMaster having 
an unknown state in Kemp 360 Central. In these cases, it is not easy to remove the LoadMaster from Kemp 360 Central and the 
unknown LoadMaster is still taking up an available license.

					

                        

                        
 Syntax 

                        

						

                            


Stop-AslInstance [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction <ActionPreference>] 
[-InformationVariable <String>] [<CommonParameters>]

Stop-AslInstance [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN <String>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Stop-AslInstance

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.

                            

						

                        
Top of page
				

				

					

						
 StopIkeDaemon 

						
WARNING: This function is deprecated. Use the following command instead:
Stop-LmVpnIkeDaemon

						
WARNING: This function is deprecated. Use the following command instead:
Stop-LmVpnIkeDaemon

					

                        

                        
 Syntax 

                        

						

                            


StopIkeDaemon [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction <ActionPreference>] 
[-InformationVariable <String>] [<CommonParameters>]

StopIkeDaemon [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN <String>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-LoadBalancer
                                        
										
										false
										false
										
									

									

										-LBPort
                                        
										
										false
										false
										
									

									

										-Credential
                                        
										
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										
										false
										false
										
									

									

										-SubjectCN
                                        
										
										false
										false
										
									

								
							

						
				
				

				

					

						
 Stop-LmVpnConnection 

						
Stop the Virtual Private Network (VPN).

						
This command allows you to stop the connection of specified VPN.

					

                        

                        
 Syntax 

                        

						

                            


Stop-LmVpnConnection -Name <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Stop-LmVpnConnection -Name <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] 
[-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-Name
                                        
										The name of the VPN.
										true
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Stop-LmVpnConnection -Name ExampleVPN

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.

                            

						

                        
Top of page
				

				

					

						
 Stop-LmVpnIkeDaemon 

						
Stop the Internet Key Exchange (IKE) daemon.

						
This command allows you to stop the IKE daemon.

					

                        

                        
 Syntax 

                        

						

                            


Stop-LmVpnIkeDaemon [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Stop-LmVpnIkeDaemon [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN <String>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Stop-LmVpnIkeDaemon

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.

                            

						

                        
Top of page
				

				

					

						
 Stop-SSODomainSession 

						
Kill all open sessions for an SSO domain, or one particular session.

						
Kill all open sessions for an SSO domain, or one particular session.

					

                        

                        
 Syntax 

                        

						

                            


Stop-SSODomainSession -Domain <String> [-Key <String>] [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Stop-SSODomainSession -Domain <String> [-Key <String>] [-LoadBalancer <String>] [-LBPort <Int32>] 
[-CertificateStoreLocation <String>] [-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable 
<String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-Domain
                                        
										Specify the domain to kill the open sessions for.
										true
										false
										
									

									

										-Key
                                        
										To kill all open sessions for the specified domain, leave this parameter blank. To kill a particular session, specify the 
cookie or <Username>,<HostIPAddress>.		
										false
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Stop-SSODomainSession -Domain qasp.com

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.

                            

						

                        
Top of page
				

				

					

						
 StopVpnConnection 

						
WARNING: This function is deprecated. Use the following command instead:
Stop-LmVpnConnection

						
WARNING: This function is deprecated. Use the following command instead:
Stop-LmVpnConnection

					

                        

                        
 Syntax 

                        

						

                            


StopVpnConnection -Name <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

StopVpnConnection -Name <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] 
[-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-Name
                                        
										
										true
										false
										
									

									

										-LoadBalancer
                                        
										
										false
										false
										
									

									

										-LBPort
                                        
										
										false
										false
										
									

									

										-Credential
                                        
										
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										
										false
										false
										
									

									

										-SubjectCN
                                        
										
										false
										false
										
									

								
							

						
				
				

				

					

						
 Test-LmGeoEnabled 

						
Will tell you if GEO is currently enabled or disabled.

						
Will tell you if GEO is currently enabled or disabled.

					

                        

                        
 Syntax 

                        

						

                            


Test-LmGeoEnabled [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction <ActionPreference>] 
[-InformationVariable <String>] [<CommonParameters>]

Test-LmGeoEnabled [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN <String>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Test-LmGeoEnabled

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.
GEO is disabled

                            

						

                        
Top of page
				

				

					

						
 Test-LmServerConnection 

						
Test the connection to the LoadMaster.

						
Test the connection to the LoadMaster.

					

                        

                        
 Syntax 

                        

						

                            


Test-LmServerConnection [-ComputerName] <String> [[-Port] <Int32>] [-InformationAction <ActionPreference>] 
[-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-ComputerName
                                        
										Enter the LoadMaster IP address.
										true
										false
										
									

									

										-Port
                                        
										Enter the Port to perform the test on.
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Test-LmServerConnection -ComputerName 172.20.1.19 -Port 443

							    
Example Output:
True

                            

						

                        
Top of page
				

				

					

						
 Test-NetworkRoute 

						
Run a traceroute.

						
This diagnostic utility determines the route to a destination by sending Internet Control Message Protocol (ICMP) echo 
packets to the destination.

					

                        

                        
 Syntax 

                        

						

                            


Test-NetworkRoute -Address <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Test-NetworkRoute -Address <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] 
[-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-Address
                                        
										The address to run the command on.
										true
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Test-NetworkRoute -Address 10.154.11.23

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.
Data field...: @{Traceroute=}
TracerouteTo : traceroute to 10.154.11.23 (10.154.11.23), 30 hops max, 60 byte packets
Hop 1        : 1  10.154.11.180  3007.251 ms !H  3007.028 ms !H  3006.995 ms !H

                            

						

                        
Top of page
				

				

					

						
 Test-SecAPIAccess 

						
This command will tell you if the API interface is enabled or disabled on the LoadMaster.

						
This command will tell you if the API interface is enabled or disabled on the LoadMaster.

					

                        

                        
 Syntax 

                        

						

                            


Test-SecAPIAccess [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction <ActionPreference>] 
[-InformationVariable <String>] [<CommonParameters>]

Test-SecAPIAccess [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN <String>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Test-SecApiAccess

							    
Example Output:
Full response: @{ReturnCode=200; Response=The API is enabled; Data=}
Return Code..: 200
Response.....: The API is enabled
7.2.39.0.14993.DEV

                            

						

                        
Top of page
				

				

					

						
 Test-ServerConnection 

						
WARNING: This function is deprecated. Use the following command instead:
Test-LmServerConnection

						
WARNING: This function is deprecated. Use the following command instead:
Test-LmServerConnection

					

                        

                        
 Syntax 

                        

						

                            


Test-ServerConnection [-ComputerName] <String> [[-Port] <Int32>] [-InformationAction <ActionPreference>] 
[-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-ComputerName
                                        
										
										true
										false
										
									

									

										-Port
                                        
										
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

								
							

						
				
				

				

					

						
 Trace-TcpTraffic 

						
Executes the tcpdump command.

						
Run a tcpdump. The tcpdump captures until the packet limit or time limit is reached (whatever is first) and returns the 
tcpdump as a pcap binary. Mime type: <application/cap>

					

                        

                        
 Syntax 

                        

						

                            


Trace-TcpTraffic [-MaxPackets <Int32>] [-MaxTime <Int32>] [-Interface <String>] [-Port <String>] [-Address <String>] 
[-TcpOptions <String>] [-Path <String>] [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-Force 
<SwitchParameter>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [-WhatIf <SwitchParameter>] 
[-Confirm <SwitchParameter>] [<CommonParameters>]

Trace-TcpTraffic [-MaxPackets <Int32>] [-MaxTime <Int32>] [-Interface <String>] [-Port <String>] [-Address <String>] 
[-TcpOptions <String>] [-Path <String>] [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] 
[-SubjectCN <String>] [-Force <SwitchParameter>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] 
[-WhatIf <SwitchParameter>] [-Confirm <SwitchParameter>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-MaxPackets
                                        
										The maximum number of packets to capture. The default value for this parameter is 10000. Valid values range from 1 to 
200000. The maximum is the API maximum - the actual maximum size is defined by the space available.		
										false
										false
										
									

									

										-MaxTime
                                        
										The maximum number of seconds to capture. The default value for this parameter is 10. Valid values range from 1 to 600.
										false
										false
										
									

									

										-Interface
                                        
										The interface(s) to monitor. The default interface is eth0. A TCP dump can be captured either by one or all Ethernet ports.
										false
										false
										
									

									

										-Port
                                        
										The port to monitor.
										false
										false
										
									

									

										-Address
                                        
										The (optional) address to monitor.
										false
										false
										
									

									

										-TcpOptions
                                        
										Any optional parameters needed. The maximum number of characters permitted is 255.
										false
										false
										
									

									

										-Path
                                        
										The path to and filename of an export of the tcpdump results.
										false
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-Force
                                        
										Enable this parameter to force the command to execute without a confirmation.
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-WhatIf
                                        wi
										Enable this parameter to see what the command will do without actually executing the command.
										false
										false
										
									

									

										-Confirm
                                        cf
										Confirms that the action should be carried out.
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

TraceTcpTraffic Address 10.154.190.207 Path c:/example2/example2

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.

---------

The TCP trace results will be saved to the specified path.

                            

						

                        
Top of page
				

				

					

						
 Uninstall-LmPatch 

						
Allows you to roll-back the LoadMaster to the previous version of firmware.

						
Allows you to roll-back the LoadMaster to the previous version of firmware. You will be asked to restart the LoadMaster for 
the command to complete.

					

                        

                        
 Syntax 

                        

						

                            


Uninstall-LmPatch [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction <ActionPreference>] 
[-InformationVariable <String>] [<CommonParameters>]

Uninstall-LmPatch [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN <String>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Uninstall-LmPatch

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.
Data field...: @{PatchData=Previous firmware version successfully restored. Please reboot the LM to apply.}

                            

						

                        
Top of page
				

				

					

						
 Uninstall-WafCustomRuleData 

						
Allows you to delete an AFP custom rule data file.

						
Allows you to delete an AFP custom rule data file.

					

                        

                        
 Syntax 

                        

						

                            


Uninstall-WafCustomRuleData -Filename <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Uninstall-WafCustomRuleData -Filename <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation 
<String>] [-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-Filename
                                        
										The filename of the custom rule data file.
										true
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Uninstall-WafCustomRuleData -Filename modsecurity_35_bad_robots

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.

                            

						

                        
Top of page
				

				

					

						
 Uninstall-WafCustomRuleSet 

						
Allows you to delete custom AFP rule file

						
Allows you to delete custom AFP rule file

					

                        

                        
 Syntax 

                        

						

                            


Uninstall-WafCustomRuleSet -Filename <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Uninstall-WafCustomRuleSet -Filename <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation 
<String>] [-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-Filename
                                        
										The filename of the custom rule.
										true
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
						

                            

                                
 Note 

                            

							
This does not delete the associated data file.
    
    If the filename specified does not match a rule file that exists in the LoadMaster, a Rule not found error will be 
    displayed.

						

                        

                            
 Examples 

                        

						

                            

							    Example

Uninstall-WafCustomRuleSet -Filename modsecurity_crs_11_brute_force

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.

                            

						

                        
Top of page
				

				

					

						
 Unregister-BondedInterface 

						
WARNING: This function is deprecated. Use the following command instead:
Unregister-NetworkBondedInterface

						
WARNING: This function is deprecated. Use the following command instead:
Unregister-NetworkBondedInterface

					

                        

                        
 Syntax 

                        

						

                            


Unregister-BondedInterface -InterfaceID <Int16> [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Unregister-BondedInterface -InterfaceID <Int16> [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation 
<String>] [-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-InterfaceID
                                        
										
										true
										false
										
									

									

										-LoadBalancer
                                        
										
										false
										false
										
									

									

										-LBPort
                                        
										
										false
										false
										
									

									

										-Credential
                                        
										
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										
										false
										false
										
									

									

										-SubjectCN
                                        
										
										false
										false
										
									

								
							

						
				
				

				

					

						
 Unregister-NetworkBondedInterface 

						
Enables you to unregister the address of a bonded interface.

						
This command waits two minutes to reconnect to the LoadMaster. If the wait time is longer than two minutes, an error 
message appears.

					

                        

                        
 Syntax 

                        

						

                            


Unregister-NetworkBondedInterface -InterfaceID <Int16> [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Unregister-NetworkBondedInterface -InterfaceID <Int16> [-LoadBalancer <String>] [-LBPort <Int32>] 
[-CertificateStoreLocation <String>] [-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable 
<String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-InterfaceID
                                        
										The ID of the interface that should be unregistered.
										true
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Unregister-NetworkBondedInterface -InterfaceID 1

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.
Data field...: @{Interface=}
Id               : 1
IPAddress        : 
InterfaceType    : Port
GeoTrafficEnable : no
DefaultInterface : no

                            

						

                        
Top of page
				

				

					

						
 Update-AFEIDSRules 

						
Upload a new ruleset.

						
To get updated or customized SNORT rules, please refer to the SNORT website: https://www.snort.org/.

					

                        

                        
 Syntax 

                        

						

                            


Update-AFEIDSRules [-Path <String>] [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Update-AFEIDSRules [-Path <String>] [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] 
[-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-Path
                                        
										The path to the rules file to be uploaded in the format <Path>\<Filename.Extension>, for example C:\t\community-rules.tar.
										false
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Update-AFEIDSRules -Path C:\t\community-rules.tar

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.

                            

						

                        
Top of page
				

				

					

						
 Update-GeoDatabase 

						
Install an updated GEO database patch file.

						
Install an updated GEO database patch file.

					

                        

                        
 Syntax 

                        

						

                            


Update-GeoDatabase -Path <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Update-GeoDatabase -Path <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] 
[-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-Path
                                        
										The path to the patch file in the format path\filename.extension
										true
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Update-GeoDatabase –Path C:\Users\ExampleUser\Downloads\geodata.patch (1)\geodata.patch\geodata.patch_2017_03_01_0104

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.

                            

						

                        
Top of page
				

				

					

						
 Update-GeoIPBlacklistDatabase 

						
Download the GEO IP blacklist database updates now.

						
To manually download updates to the GEO IP blacklist database, run this command.

					

                        

                        
 Syntax 

                        

						

                            


Update-GeoIPBlacklistDatabase [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Update-GeoIPBlacklistDatabase [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN 
<String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Update-GeoIPBlacklistDatabase

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed. Download of new GEO IP Blacklist data successfully 
completed.; Data=}
Return Code..: 200
Response.....: Command successfully executed. Download of new GEO IP Blacklist data successfully completed.

                            

						

                        
Top of page
				

				

					

						
 Update-LicenseOffline 

						
License the LoadMaster using the offline method.

						
Offline licensing requires a Binary Large OBject (BLOB) file which is provided by Kemp. The License BLOB is emailed to the 
customer when requested. Each time a license is updated a new BLOB is needed. The BLOB must be copied and pasted into a 
text file (in the following example the file is called license.txt).

					

                        

                        
 Syntax 

                        

						

                            


Update-LicenseOffline -Path <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Update-LicenseOffline -Path <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] 
[-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-Path
                                        
										The path to the license BLOB file, including the filename and extension.
										true
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Update-LicenseOffline -Path
C:\ExamplePath\blob.txt

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.

                            

						

                        
Top of page
				

				

					

						
 Update-LicenseOnline 

						
Update the LoadMaster's license online.

						
Cause the LoadMaster to query the Kemp licensing system for an updated license.

					

                        

                        
 Syntax 

                        

						

                            


Update-LicenseOnline -KempId <String> -Password <String> [-OrderId <String>] [-http_proxy <String>] [-LoadBalancer 
<String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] 
[<CommonParameters>]

Update-LicenseOnline -KempId <String> -Password <String> [-OrderId <String>] [-http_proxy <String>] [-LoadBalancer 
<String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN <String>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-KempId
                                        
										The email address you used when registering for a Kemp ID.
										true
										false
										
									

									

										-Password
                                        
										The password of your Kemp ID account.
										true
										false
										
									

									

										-OrderId
                                        
										The Orderid parameter is only needed for Virtual LoadMasters. The Order ID is provided by Kemp after a license is purchased.
										false
										false
										
									

									

										-http_proxy
                                        
										You can optionally use a HTTP(S) proxy to connect to the licensing server. Specify the HTTP(S) proxy server and port, in 
the format <ProxyAddress>:<Port>.		
										false
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Update-LicenseOnline -KempId exampleuser@examplecompany.com -Password examplepassword

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.

                            

						

                        
Top of page
				

				

					

						
 Update-LmDNSCache 

						
WARNING: This function is deprecated. Use the following command instead:
Update-NetworkDNSCache

						
WARNING: This function is deprecated. Use the following command instead:
Update-NetworkDNSCache

					

                        

                        
 Syntax 

                        

						

                            


Update-LmDNSCache [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction <ActionPreference>] 
[-InformationVariable <String>] [<CommonParameters>]

Update-LmDNSCache [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN <String>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Update-LmDnsCache

							    
Example Output:
ReturnCode Data Response                     
---------- ---- --------                     
       200      Command successfully executed

                            

						

                        
Top of page
				

				

					

						
 Update-NetworkDNSCache 

						
Force a new resolution of DNS names.

						
The LoadMaster will try to resolve the DNS names:
• If the address is not found, or if it is the same as before – nothing is done (except a log entry is generated).
• If the address is different, the Real Server entry will be updated with the new address, if possible.
• If the new address is invalid for some reason, for example if it is a non-local address and the Non-Local Real Servers 
setting has been disabled, no changes are made and a log is generated.

					

                        

                        
 Syntax 

                        

						

                            


Update-NetworkDNSCache [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Update-NetworkDNSCache [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN 
<String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Update-NetworkDNSCache

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.

                            

						

                        
Top of page
				

				

					

						
 Update-WafRulesDatabase 

						
Manually trigger the installation of downloaded rules.

						
Manually trigger the installation of downloaded Web Application Firewall (WAF) rules.

					

                        

                        
 Syntax 

                        

						

                            


Update-WafRulesDatabase [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Update-WafRulesDatabase [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN 
<String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										Specify the port to communicate with the LoadMaster on.
Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this 
is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default 
Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in 
the specified location, for example, Cert:\<CurrentUser>\TrustedPeople.
Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. 
If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to 
overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-SubjectCN
                                        
										This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), 
which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the 
CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location.
Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

								
							

						
				
                        

                            
 Examples 

                        

						

                            

							    Example

Update-WafRulesDatabase

							    
Example Output:
Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=}
Return Code..: 200
Response.....: Command successfully executed.

                            

						

                        
Top of page
				

				

					

						
 UploadAddon 

						
WARNING: This function is deprecated. Use the following command instead:
Install-LmAddon

						
WARNING: This function is deprecated. Use the following command instead:
Install-LmAddon

					

                        

                        
 Syntax 

                        

						

                            


UploadAddon -Path <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

UploadAddon -Path <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN 
<String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-Path
                                        
										
										true
										false
										
									

									

										-LoadBalancer
                                        
										
										false
										false
										
									

									

										-LBPort
                                        
										
										false
										false
										
									

									

										-Credential
                                        
										
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										
										false
										false
										
									

									

										-SubjectCN
                                        
										
										false
										false
										
									

								
							

						
				
				

				

					

						
 UploadRSAConfigurationFile 

						
WARNING: This function is deprecated. Use the following command instead:
Get-SSODomainSession

						
WARNING: This function is deprecated. Use the following command instead:
Get-SSODomainSession

					

                        

                        
 Syntax 

                        

						

                            


UploadRSAConfigurationFile -Path <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

UploadRSAConfigurationFile -Path <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] 
[-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-Path
                                        
										
										true
										false
										
									

									

										-LoadBalancer
                                        
										
										false
										false
										
									

									

										-LBPort
                                        
										
										false
										false
										
									

									

										-Credential
                                        
										
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										
										false
										false
										
									

									

										-SubjectCN
                                        
										
										false
										false
										
									

								
							

						
				
				

				

					

						
 UploadRSANodeSecretAndPassword 

						
WARNING: This function is deprecated. Use the following command instead:
Stop-SSODomainSession

						
WARNING: This function is deprecated. Use the following command instead:
Stop-SSODomainSession

					

                        

                        
 Syntax 

                        

						

                            


UploadRSANodeSecretAndPassword -Password <String> -Path <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential 
<Object>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

UploadRSANodeSecretAndPassword -Password <String> -Path <String> [-LoadBalancer <String>] [-LBPort <Int32>] 
[-CertificateStoreLocation <String>] [-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable 
<String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-Password
                                        
										
										true
										false
										
									

									

										-Path
                                        
										
										true
										false
										
									

									

										-LoadBalancer
                                        
										
										false
										false
										
									

									

										-LBPort
                                        
										
										false
										false
										
									

									

										-Credential
                                        
										
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										
										false
										false
										
									

									

										-SubjectCN
                                        
										
										false
										false
										
									

								
							

						
				
				

				

					

						
 UploadTemplate 

						
WARNING: This function is deprecated. Use the following command instead:
Install-Template

						
WARNING: This function is deprecated. Use the following command instead:
Install-Template

					

                        

                        
 Syntax 

                        

						

                            


UploadTemplate -Path <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction 
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

UploadTemplate -Path <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN 
<String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-Path
                                        
										
										true
										false
										
									

									

										-LoadBalancer
                                        
										
										false
										false
										
									

									

										-LBPort
                                        
										
										false
										false
										
									

									

										-Credential
                                        
										
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										
										false
										false
										
									

									

										-SubjectCN
                                        
										
										false
										false
										
									

								
							

						
				
				

				

					

						
 UserChangeLocalPassword 

						
WARNING: This function is deprecated. Use the following command instead:
Set-SecUserPassword

						
WARNING: This function is deprecated. Use the following command instead:
Set-SecUserPassword

					

                        

                        
 Syntax 

                        

						

                            


UserChangeLocalPassword -User <String> -Password <String> -Radius <Int32> [-LoadBalancer <String>] [-LBPort <Int32>] 
[-Credential <Object>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

UserChangeLocalPassword -User <String> -Password <String> -Radius <Int32> [-LoadBalancer <String>] [-LBPort <Int32>] 
[-CertificateStoreLocation <String>] [-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable 
<String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-User
                                        
										
										true
										false
										
									

									

										-Password
                                        
										
										true
										false
										
									

									

										-Radius
                                        
										
										true
										false
										
									

									

										-LoadBalancer
                                        
										
										false
										false
										
									

									

										-LBPort
                                        
										
										false
										false
										
									

									

										-Credential
                                        
										
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										
										false
										false
										
									

									

										-SubjectCN
                                        
										
										false
										false
										
									

								
							

						
				
				

				

					

						
 UserSetPermissions 

						
WARNING: This function is deprecated. Use the following command instead:
Set-SecUserPermission

						
WARNING: This function is deprecated. Use the following command instead:
Set-SecUserPermission

					

                        

                        
 Syntax 

                        

						

                            


UserSetPermissions -User <String> -Permissions <String> [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

UserSetPermissions -User <String> -Permissions <String> [-LoadBalancer <String>] [-LBPort <Int32>] 
[-CertificateStoreLocation <String>] [-SubjectCN <String>] [-InformationAction <ActionPreference>] [-InformationVariable 
<String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-User
                                        
										
										true
										false
										
									

									

										-Permissions
                                        
										
										true
										false
										
									

									

										-LoadBalancer
                                        
										
										false
										false
										
									

									

										-LBPort
                                        
										
										false
										false
										
									

									

										-Credential
                                        
										
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										
										false
										false
										
									

									

										-SubjectCN
                                        
										
										false
										false
										
									

								
							

						
				
				

				

					

						
 UserSetSystemPassword 

						
WARNING: This function is deprecated. Use the following command instead:
Set-SecSystemUserPassword

						
WARNING: This function is deprecated. Use the following command instead:
Set-SecSystemUserPassword

					

                        

                        
 Syntax 

                        

						

                            


UserSetSystemPassword [-CurrentPassword] <String> [-NewPassword] <String> [[-LoadBalancer] <String>] [[-LBPort] <Int32>] 
[[-Credential] <Object>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-CurrentPassword
                                        
										
										true
										false
										
									

									

										-NewPassword
                                        
										
										true
										false
										
									

									

										-LoadBalancer
                                        
										
										false
										false
										
									

									

										-LBPort
                                        
										
										false
										false
										
									

									

										-Credential
                                        
										
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

								
							

						
				
				

				

					

						
 VSAddWafRule 

						
WARNING: This function is deprecated. Use the following command instead:
New-AdcVsWafRule

						
WARNING: This function is deprecated. Use the following command instead:
New-AdcVsWafRule

					

                        

                        
 Syntax 

                        

						

                            


VSAddWafRule -VS <String> -VSPort <String> -VSProtocol <String> -Rule <String> [-Enablerules <String>] [-Disablerules 
<String>] [-LoadBalancer <String>] [-LBPort <Int32>] [-Credential <Object>] [-InformationAction <ActionPreference>] 
[-InformationVariable <String>] [<CommonParameters>]

VSAddWafRule -VS <String> -VSPort <String> -VSProtocol <String> -Rule <String> [-Enablerules <String>] [-Disablerules 
<String>] [-LoadBalancer <String>] [-LBPort <Int32>] [-CertificateStoreLocation <String>] [-SubjectCN <String>] 
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-VS
                                        
										The IP address of the relevant Virtual Service.
										true
										false
										
									

									

										-VSPort
                                        
										
										true
										false
										
									

									

										-VSProtocol
                                        
										
										true
										false
										
									

									

										-Rule
                                        
										Specify the name of the rule to be assigned.
The rule name must be preceded with a letter/word and a forward slash. The letter used depends on the type of rule being 
added:
  - C or Custom
  - Z  or ApplicationGeneric
  - A or ApplicationSpecific
  - G or Generic		
										true
										false
										
									

									

										-Enablerules
                                        
										
										false
										false
										
									

									

										-Disablerules
                                        
										
										false
										false
										
									

									

										-LoadBalancer
                                        
										Specify the address of the LoadMaster to run the command on.
Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If 
this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.		
										false
										false
										
									

									

										-LBPort
                                        
										
										false
										false
										
									

									

										-Credential
                                        
										The username to connect to the LoadMaster with.
Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is 
done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it.
When running PowerShell commands, either authenticate using the username (Credential) and password, or use 
certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.		
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										
										false
										false
										
									

									

										-SubjectCN
                                        
										
										false
										false
										
									

									

										-Port
                                        
										Specifies the port on which this Virtual Service accepts connections.
										true
										false
										
									

									

										-Prot
                                        
										Specifies the communication protocol of the Virtual Service. Valid options are TCP or UDP.
										true
										false
										
									

								
							

						
				
						

                            

                                
 Note 

                            

							
The rule name must be preceded with the relevant letter/word and a forward slash. The letter/word used depends on the 
    type of rule being assigned.
    
    This is case sensitive. The letter/word needs to be in the correct case for the command to work.
    
    • C or Custom
      • Z  or ApplicationGeneric
      • A or ApplicationSpecific
      • G or Generic
    
    Multiple rules can be assigned in the same command by separating them with a space.
    
    An invalid rule error will display if the name of the rule is not entered correctly, if the preceding letter is 
    incorrect, or if the does not exist in the LoadMaster.

						

                        

                            
 Examples 

                        

						

                            

							    Example

VSAddWafRule -VS 10.11.0.31 -Port 80 -Prot tcp -Rule C/modsecurity_crs_11_brute_force

							    
Example Output:
ok

                            

						

                        
Top of page
				

				

					

						
 VSListWafRuleIds 

						
WARNING: This function is deprecated. Use the following command instead:
Get-AdcVsWafRule

						
WARNING: This function is deprecated. Use the following command instead:
Get-AdcVsWafRule

					

                        

                        
 Syntax 

                        

						

                            


VSListWafRuleIds -VS <String> -VSPort <String> -VSProtocol <String> -Rule <String> [-LoadBalancer <String>] [-LBPort 
<Int32>] [-Credential <Object>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

VSListWafRuleIds -VS <String> -VSPort <String> -VSProtocol <String> -Rule <String> [-LoadBalancer <String>] [-LBPort 
<Int32>] [-CertificateStoreLocation <String>] [-SubjectCN <String>] [-InformationAction <ActionPreference>] 
[-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-VS
                                        
										
										true
										false
										
									

									

										-VSPort
                                        
										
										true
										false
										
									

									

										-VSProtocol
                                        
										
										true
										false
										
									

									

										-Rule
                                        
										
										true
										false
										
									

									

										-LoadBalancer
                                        
										
										false
										false
										
									

									

										-LBPort
                                        
										
										false
										false
										
									

									

										-Credential
                                        
										
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										
										false
										false
										
									

									

										-SubjectCN
                                        
										
										false
										false
										
									

								
							

						
				
				

				

					

						
 VSRemoveWafRule 

						
WARNING: This function is deprecated. Use the following command instead:
Remove-AdcVsWafRule

						
WARNING: This function is deprecated. Use the following command instead:
Remove-AdcVsWafRule

					

                        

                        
 Syntax 

                        

						

                            


VSRemoveWafRule -VS <String> -VSPort <String> -VSProtocol <String> -Rule <String> [-LoadBalancer <String>] [-LBPort 
<Int32>] [-Credential <Object>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

VSRemoveWafRule -VS <String> -VSPort <String> -VSProtocol <String> -Rule <String> [-LoadBalancer <String>] [-LBPort 
<Int32>] [-CertificateStoreLocation <String>] [-SubjectCN <String>] [-InformationAction <ActionPreference>] 
[-InformationVariable <String>] [<CommonParameters>]

                            

						

						

							
 Parameters 

							

								
									

										Name
                                        Alias
										Description
										Required?
										Pipeline Input
										Default Value
									

								
								
									

										-VS
                                        
										
										true
										false
										
									

									

										-VSPort
                                        
										
										true
										false
										
									

									

										-VSProtocol
                                        
										
										true
										false
										
									

									

										-Rule
                                        
										
										true
										false
										
									

									

										-LoadBalancer
                                        
										
										false
										false
										
									

									

										-LBPort
                                        
										
										false
										false
										
									

									

										-Credential
                                        
										
										false
										false
										
									

									

										-InformationAction
                                        infa
										
										false
										false
										
									

									

										-InformationVariable
                                        iv
										
										false
										false
										
									

									

										-CertificateStoreLocation
                                        
										
										false
										false
										
									

									

										-SubjectCN
                                        
										
										false
										false